Forem: ranms25

OSDC-2023-weather-app

ranms25 — Sat, 17 Jun 2023 09:22:26 +0000

Quick review of the lecture at the course OSDC

This week
During the session, we discussed project selection for contributions and focused on Docker Compose. We learned Docker commands and how to use them. Docker Compose simplifies managing multi-container applications, and @szabgab also demonstrated how hands-on using it. We briefly touched on cloud providers like Linode and Digital Ocean.

Assignment

Our task this time was to create an open-source project

Python-Weather-App project

I really like weather, so I thought it would be nice to develop a nice little app that would bring me real-time weather data for various places in the world

Here's a summary of the steps I have taken:

Certainly! Here's an improved summary of the steps you've taken for your Python Weather App project:

I created a GitHub repository named Python-Weather-App to host my weather application project.
I installed the necessary packages that you can see in the requirements.txt file I created.
I obtained an API key from OpenWeatherMap by visiting their website and creating an account. This API key is necessary to make API requests and retrieve weather data.
I designed a command-line user interface for the weather app, allowing users to input a location for which they want to fetch weather information.
I implemented the core functionality of the app in the weather_app.py file. This involved making API requests to OpenWeatherMap using the requests library, parsing the JSON response to extract relevant weather information (such as temperature, humidity, weather conditions, wind speed, rainfall, and snowfall), and displaying the information to the user.
I utilized the dotenv library and created a .env file where the API key can be stored. This file is included in the repository and users are instructed to add their own API key to the file.
I added error handling to the app to gracefully handle situations such as invalid locations or issues with the API request. When errors occur, appropriate error messages are displayed to the user.
The project's README file provides clear instructions for users on how to install the necessary dependencies, add their API key to the .env file, and run the weather app. Additionally, the README file includes instructions on running tests for the weather application using pytest.
The repository is published on GitHub, allowing others to view and contribute to the project.

It was quite challenging and took a long time. In spite of that, it was good to see the course material come together in a practical way.

Stay tuned!

OSDC-2023-Assignment 11

ranms25 — Sun, 11 Jun 2023 17:54:03 +0000

Quick review of the lecture at the course OSDC

This week During this week's session on Testing with PyTest, we learned various concepts and techniques. We started the session with an introduction to testing using pytest. Covered topics such as test methods, demo tools in Python, an application under test (AUT), regression testing, doctest, and unit test. @szabgab also demonstrated how pytest can be used alongside unit test and doctest for comprehensive testing. Test coverage, pytest setup, and examples of tests were discussed as well.

Also, we focused on additional features and functionalities. Gabor explained pytest's handling of expected exceptions, changing text, missing exceptions, and raised exceptions. We also covered topics like exercise-testing exceptions, multiple failures, selective running of test functions, stopping on the first failure, and expecting a test to fail. The session included discussions on command-line options such as -rx, skip tests, show extra tests, and verbose and quiet modes.

Overall, the session provided a comprehensive overview of testing with PyTest and equipped us with various techniques and tools to write effective tests for Python applications.

Assignment

Find an open-source project, and write some tests for a part of the code that did not have tests. Send it as a Pull-Request.

Irish-C/calculator-class-program project

I created several test files to validate different aspects of the calculator program. These files are test_calculator.py, test_calculator_extended.py, test_gui.py, test_gui_extended.py, and test_user_validation.py.

`test_calculator.py`

This file contains tests to verify the basic functionality of the calculator class. The tests cover operations such as addition, subtraction, multiplication, and division. Here's an example test from the file:

def test_add():
    calculator = Calculator()
    assert calculator.add(2, 3) == 5

`test_calculator_extended.py`

In this file, I expanded the tests to cover more complex scenarios. The tests include operations with negative numbers, decimal numbers, and large numbers to ensure accurate calculations.

`test_gui.py`

The test_gui.py file focuses on testing the graphical user interface (GUI) of the calculator. The tests verify if GUI elements are displayed correctly and if button clicks trigger the appropriate actions. Here's an example test:

def test_clear():
    gui = TkinterGUI()

    # Set the inputs
    gui.num1_entry.insert(0, "2")
    gui.num2_entry.insert(0, "3")
    gui.operation_var.set("Addition")

    # Call the clear method
    gui.clear()

    # Check if inputs and selection are cleared
    assert gui.operation_var.get() == "Select Operation"
    assert gui.num1_entry.get() == ""
    assert gui.num2_entry.get() == "" "

`test_user_validation.py`

In this file, I wrote tests to validate user input. The tests ensure that the calculator class properly handles invalid inputs, such as non-numeric characters and division by zero. Here's an example test:

 def test_validate_user_addition(self):
     uv = UserValidation()
     result = uv.validate_user(2, 3, 'Addition')
     assert result == 5"

To run the tests, use the pytest command in the PowerShell terminal while inside the "calculator-class-program" directory. pytest will collect the test items from the files and execute them, displaying the progress and results.

During the test execution, all tests passed successfully, indicating that the relevant parts of the calculator program are functioning correctly.

Overall, the test files were created to validate different aspects of the calculator program, including basic calculations, extended operations, GUI functionality, and user input validation. The tests help ensure the accuracy and robustness of the calculator application.

Calculator-Class-Program GitHub Action

This GitHub Action enables the automation of the testing process for the Irish-C/calculator-class-program project. The action is triggered whenever there is a push or pull request event in the repository. It sets up the necessary environment, installs dependencies, and runs the test suite using the PyTest framework.

Test Results

The GitHub Action provides detailed test results, indicating the pass or fail status of each test case. These results can be reviewed in the GitHub Actions tab of the repository. Any failures or errors will be displayed, helping identify any issues in the calculator-class-program code.

By leveraging this GitHub Action, the Irish-C/calculator-class-program project benefits from automated testing, ensuring the reliability and accuracy of the calculator program. Developers can easily identify and address any issues that arise, promoting code quality and maintainability.

Keep following along as I continue to learn and make progress week after week!

OSDC-Github actions

ranms25 — Sat, 13 May 2023 17:49:50 +0000

This week we learned about "Continuous Integration for GitHub projects" We covered the basics of GitHub Actions and provided examples of how to use them. The presentation included a demonstration of a simple workflow and implementation, examples of how to trigger jobs, and an overview of environment variables and repositories. Take a look:
GitHub Actions examples
slides: Continuous Integration for GitHub projects
Collection of official GitHub Actions
capturecli, simple python project with CI

We also discussed the use of a matrix strategy and presented examples of Linux commands with GitHub Actions.

The assignment for the session was to find a project with tests but without continuous integration and set up a GitHub Action to run the tests, then show the results to before sending the pull request to the project owner.

Contribution to Automated Testing: Adding GitHub Actions Workflow to cybrid-api-organization-python

I hope to contribute to this project. I created a GitHub Actions workflow file named "CI" that runs automated tests on multiple operating systems and Python versions to ensure code quality and consistency. The workflow is triggered by push and pull request events as well as manually through the GitHub web interface.

The matrix strategy allows the workflow to test the code on Ubuntu, macOS, and Windows using Python 3.9, 3.10, and 3.11. The setup-python action installs the necessary version of Python, while the install dependencies step installs the required dependencies from the requirements.txt and test-requirements.txt files.

The final step runs the pytest command to execute the test cases. The workflow provides developers with feedback on the quality of their code and alerts them to any issues or errors that need attention.

This automated testing process helps maintain a high level of code quality and ensures that the code is consistent across different operating systems and Python versions. It saves developers time and effort by catching issues early in the development process, allowing them to focus on developing new features and improving existing ones.

Learning and progressing from week to week, keep following :)

OSDC-2023-assignment7

ranms25 — Fri, 05 May 2023 13:10:56 +0000

This week we learned how to configure git-scm on Windows, including setting the default editor and configuring global and local repository settings. We also learned about the process of cloning, forking, and pulling repositories, as well as creating and pushing repositories to GitHub. Additionally, we were introduced to basic git workflows, including branching, adding, committing, and pushing changes to a repository. Finally, we learned about advanced git commands, such as rebasing and force pushing, to manage changes to a repository.
This week's task was to take one project, set up the local development environment, and send a PR.
I chose the open-source-by-organizations.
When I first set up the development environment, I ran into a problem towards the end with the command:
python generate.py github/bioinform.yaml github/calgaryml.yaml
I contacted @szabgab and he explained to me that he moved the files to a subfolder called 'data' and have not updated the README file
So I opened a PR in order to correct the problem, in retrospect it would have been better to open issue and only then send the PR.
In addition, after the aforementioned correction, I encountered another problem, this time I opened an issue directly.
After doing this I noticed that the main page of the project is written as a sentence:
"Currently there are 190 Corporations, 15 Non Profits, 216 Universities, 50 Governments, 2 Other organisations listed on our site."
And I thought it would be better to show it as a table. I opened a PR and waiting to see what @szabgab thinks about it and whether it is worthwhile.
Among the steps I did was go through the steps of setting up a development environment in the README file
And I continued with the some of the following steps:

git checkout -b ranms25/add: This command creates a new branch called "ranms25/add" and switches to it. The -b flag tells Git to create the new branch if it doesn't already exist.
vi index.html: This command opens the file "index.html" in the Vim text editor. You can edit the file in Vim and save your changes by typing :wq and pressing Enter.
git remote add fork git@github.com:ranms25/open-source-by-organizations.git: This command adds a new remote called "fork" to your local Git repository. The remote's URL is git@github.com:ranms25/open-source-by-organizations.git. This command is typically used when you want to push changes to a forked repository.
git push --set-upstream fork ranms25/add: This command pushes your local branch "ranms25/add" to the remote repository "fork". The --set-upstream flag tells Git to set the "fork" remote as the default remote for the "ranms25/add" branch. This means that in the future, you can simply run git push without specifying the remote and branch names.

As a result, I did a git push directly after Gabor asked me to fix the code, and it had already been added to the new PR.
There was a lot we learned this week, and I feel that each lesson I am learning more and understanding more. I hope to continue learning in this way, keep following!

OSDC-2023-assignment6

ranms25 — Fri, 28 Apr 2023 09:07:29 +0000

This week we started learning a new and fascinating subject "Doker".
We reviewed what a "Docker" image is and saw how to set up a development environment with its help.

We went over the slides of Learning Linux in a Docker container up before the slide about CentOS.
Then we saw a few examples of Open source project in Docker

Source of all the slides

With the help of what we learned we got a task: Setup the local development environment open source projects - in your preferred programming language - for me, Python is my preferred programming language :).
The task was a bit complex and took some time, because it was important for me to find suitable projects that did not have a description for setting up a development environment using Docker, to install and adjust the environment according to what we envisioned in class, as well as to also run tests that the environment that was uploaded is indeed normal and good.

Setting up a development environment with Docker for mobility

Make sure you have Docker installed on your machine.
Clone the repository to your local machine using Git. For example, you can run the following command in your terminal: git clone https://github.com/mobility-team/mobility.git
Navigate to the project directory: cd mobility
Create a Docker container:

For Windows:

CMD:
docker run -it --name mobility-dev -w /opt -v %cd%:/opt python:3.9 bash

PowerShell:
docker run -it --name mobility-dev -w /opt -v ${PWD}:/opt python:3.9 bash

For Linux:
docker run -it --name mobility-dev -w /opt -v $(PWD):/opt python:3.9 bash

Install the required dependencies: pip install -r requirements.txt && pip install -e .
Install the pytest package: pip install pytest
Run the unit tests to make sure everything is working properly: pytest
Starts a Docker container docker container start -i mobility-dev

Setting up a development environment with Docker for Cosmo-Tech

Make sure you have Docker installed on your machine.
Clone the repository to your local machine using Git. For example, you can run the following command in your terminal: git clone https://github.com/Cosmo-Tech/CosmoTech-Acceleration-Library.git
Navigate to the project directory: cd CosmoTech-Acceleration-Library
Create a Docker container:

For Windows:

CMD:
docker run -it --name cosmotech-acceleration-library-dev -w /opt -v %cd%:/opt python:3.11 bash

PowerShell:
docker run -it --name cosmotech-acceleration-library-dev -w /opt -v ${PWD}:/opt python:3.11 bash

For Linux:
docker run -it --name cosmotech-acceleration-library-dev -w /opt -v $(PWD):/opt python:3.11 bash

Install the required dependencies: pip install -r requirements.txt
Install the pytest package: pip install pytest
Run the unit tests to make sure everything is working properly: pytest
Starts a Docker container docker container start -i cosmotech-acceleration-library-dev

Setting up a development environment with Docker for PHX

Make sure you have Docker installed on your machine.
Clone the repository to your local machine using Git. For example, you can run the following command in your terminal: git clone https://github.com/PH-Tools/PHX.git
Navigate to the project directory: cd PHX
Create a Docker container:

For Windows:

CMD:
docker run -it --name phx-dev dev -w /opt -v %cd%:/opt python:3.7 bash

PowerShell:
docker run -it --name phx-dev -w /opt -v ${PWD}:/opt python:3.7 bash

For Linux:
docker run -it --name phx-dev -w /opt -v $(PWD):/opt python:3.7 bash

Install the required dependencies: pip install -r dev-requirements.txt && pip install -e .
Run the unit tests to make sure everything is working properly: pytest
Starts a Docker container docker container start -i phx-dev

Setting up a development environment with Docker for pymx2

Make sure you have Docker installed on your machine.
Clone the repository to your local machine using Git. For example, you can run the following command in your terminal: git clone https://github.com/vpaeder/pymx2.git
Navigate to the project directory: cd pymx2
Create a Docker container: docker run -it --name pymx2-dev -v /opt/pymx2 -v /$(pwd):/opt python:3.11 bash
Install the required dependencies: python -m setup install
Run the unit tests to make sure everything is working properly: python -m unittest
Starts a Docker container docker container start -i pymx2-dev

Setting up a development environment with Docker for cybrid-api-id-python

Make sure you have Docker installed on your machine.
Clone the repository to your local machine using Git. For example, you can run the following command in your terminal: git clone https://github.com/Cybrid-app/cybrid-api-id-python.git
Navigate to the project directory: cd cybrid-api-id-python
Create a Docker container:

For Windows:

CMD:
docker run -it --name cybrid-api-id-python-dev -w /opt -v %cd%:/opt python:3.11 bash

PowerShell:
docker run -it --name cybrid-api-id-python-dev -w /opt -v ${PWD}:/opt python:3.11 bash

For Linux:
docker run -it --name cybrid-api-id-python-dev -w /opt -v $(PWD):/opt python:3.11 bash

Install the required dependencies: pip install -r requirements.txt && pip install pytest
Run the unit tests to make sure everything is working properly: pytest
Starts a Docker container docker container start -i cybrid-api-id-python-dev

The search took a long time, and so did the installation.
Because, There are projects I've seen that have a description of the installation, and for some of them it was sometimes difficult to understand how to set up an environment, and if I was able to set up then the tests they wanted were not good and did not pass, I tried to also find projects that would really want to use Docker.

I wrote in the PR the following reasons why I think it is important to add the above information:

Ease of onboarding: new contributors or developers joining the project may not be familiar with the required software and libraries needed to develop and run the project. Providing clear instructions on how to set up a local development environment using Docker, it makes it easier for them to get up and running quickly.
Reproducibility: By using Docker to set up the local development environment, it ensures that all developers are using the same development environment with the same versions of software and libraries. This makes it easier to reproduce bugs and issues reported by other developers, as well as ensure that the project is built and tested in a consistent manner across different environments.
Isolation: Docker allows developers to create a containerized environment that is isolated from the host system, preventing potential conflicts with other software installed on the host. This helps ensure that the project's dependencies do not conflict with other software, potentially causing issues or breaking the development environment

Additionally, I sent to Open source project in Docker which is managed by @szabgab these projects as a PR to add slides and examples in this case for Python projects.

Note:
About pymx2 PR.
This PR has been written for git-scm.
The maintainer reviewed my contribution, they declined it, citing technical reasons related to the driver needing access to a serial port and the driver not being meant to be a standalone app. I realized that Dockerizing the driver may not be feasible, as it requires access to a physical device that cannot be accessed from within a Docker container.

Through this experience, I learned that not all contributions may be suitable for every project, and it is important to understand the technical requirements and design considerations of a project before making contributions (I did try to do this and it takes a lot of time and I tried to choose suitable projects, and I hope to improve on this in the future). I also gained a better understanding of the limitations of Docker and how it may not be the best option for certain types of applications, particularly those that require access to hardware devices like serial ports.

In conclusion, while my pull request was declined, I appreciate the feedback from the maintainer and the opportunity to learn more about the project and its technical requirements. I will continue to contribute to open-source projects and keep these lessons in mind in the future.

Hopefully, we will get into Docker in the next lesson and dive deeper.

OSDC-2023-assignment5

ranms25 — Sat, 15 Apr 2023 16:51:06 +0000

Quick review of the lecture at the course OSDC

@szabgab advised us how to better search for projects that would suit us better in terms of the ability to contribute to them and improve them.

We learned in more detail How to update a PR that was not accepted yet:

Created a new PR that failed the CI, and the owner commented on it as well.
After finding the fork and branch in the fork, we updated the file.
The PR was automatically updated and the CI was restarted.

During our discussion, we discussed (in theory) how to handle a change to an open source project that might take a month to complete.

What we can do to prevent breakage caused by changes made on the main project that conflict with the change we make.
It is impossible to completely avoid those conflicts, but we can reduce their impact by communicating and aligning our work frequently with the main branch.
There was a mention of rebasing. Later, we'll see how it works. In a brief discussion, we discussed whether open source work is paid.

Assignment

Our assignment was to Fix the PRs that are problematic. (Where the CI failed or where the owner asked for an update) from assignment 4
Find more projects via PyDigger, and create more PR try this time to make it more interesting and more challenging.
Add better projects to our JSON (that are not ours).

My update from last time,
vortexpy - I am still waiting for approval
stormlock - Was accepted 😊
unformat - Was accepted 😊
MathTranslate - It was not accepted and we were not able to get an answer as to why 🤷‍♂️
crypt-dir - Was accepted 😊
frontend - It was not accepted, but we get a response why not: "Not needed here, it's not meant for regular consumption." So respect that

This time I hope to contribute to the following projects:
vmn
magic_duckdb
megabots

By Added licenses to the metadata file (i.e. pyproject.toml, setup.py to appear in the website pypi.org

Additionally, I contributed to the project pydigger
You can see some of the changes I made on the page docs/license
By adding several values that can help and better summarize where and how to add the "license" field.
For example:
add a field called license to the setup function in the setup.py of the project or add the same field under [build-system] in pyproject.toml file.

Here is the section of the setup.py file:

    setuptools.setup(
    name="name of the project",
    version="1.1.7",
    author="Foo Bar",
    author_email="Foo.Bar.contact@Foo.com",
    license="MIT"

Here is the section of the pyproject.toml files:

    [build-system]
    requires = ["poetry>=0.12"]
    build-backend = "poetry.masonry.api"
    license = "Apache-2.0"

Also, I looked for some projects that would interest me, including four in the medical field dealing with the curve in the spine caused by scoliosis.
Mainly, an Ensemble Deep Learning Approach to Classify Scoliosis and Healthy Subjects
Vertebra-Landmark-Detection
Scoliosis
scoliosisx
Deep-Learning-to-Classify-Scoliosis
Another earthquake-related project-A dashboard to visualize earthquakes worldwide since 2000.
earthquakes
And a nice project on how to build a Simple AWS Rekognition Application within 15 mins.
rekognition-demo

I hope to continue learning from the course, which has taught me many new and important things that will help me in the future. :) Have a great day!

OSDC-2023-assignment4

ranms25 — Sat, 01 Apr 2023 18:45:24 +0000

Quick review of the lecture at the course OSDC

We get familiar with the PyDigger website, and learned about the different metadata which is important to have in the details of the various projects, for example, license, author name, a summary of the project, and so on.
We looked at pypi page of numpy
We found that the mrflagly project was missing the author field from the meta-data, so we sent PR, and learn about pyproject.toml
@szabgab mentioned the recommended books listed at the bottom of the OSDC main page. Especially Uncurled by Daniel Stenberg, author of curl.

Assignment

Our assignment was to Find 5 projects via PyDigger that have no author, not license, or no VCS. Add the missing information and send a PR.
And in this way contribute to the projects

I hope to contribute to the following projects:

vortexpy
stormlock
unformat
MathTranslate
crypt-dir
frontend

By Added licenses to the metadata file (i.e. pyproject.toml, setup.py to appear in the website pypi.org

OSDC-2023-assignment3

ranms25 — Fri, 24 Mar 2023 14:57:46 +0000

Today in class at the course OSDC

we download and install the git client from git-scm. We set up local git configure, clone, add, commit, etc. In Windows, we start the git-bash application, Create a Github page locally, and on Github create the USERNAME.github.io repository.

Second assignment

Our assignment was to create a website using GitHub pages, with a cv, projects, and more Informative information. Adding a link to our course site, and a link to my blog.
I am very happy with the result look here

During the task, these are some of the steps I took:

Within GitHub create a new repository the name must be: github_username.github.io.
Install Git CLI from git-scm
Clone the repository locally via ssh. In the git-bash application, I wrote: ssh-keygen.exe and search in .ssh/ for the public key. Copy it to my profile: setting-> SSH and GPG keys-> new SSH key. Give it a title, paste the key, and press 'Add SSH key'.
Create a new file named index.md with vim add, commit, and push to my new repo.
Create a new file named _config.yml, I used this guide-to configure my web pages theme. supported themes for GitHub pages
Adding CV and writing more information about myself, GitHub automatically generates HTML from my markdown files using Jekyll

From lesson to lesson, I am learning a lot and hope to continue :)

OSDC-2023-second-assignment

ranms25 — Thu, 16 Mar 2023 19:48:44 +0000

Today in class at the course OSDC

we go over the PRs that we opened and fix issues in PR instead of opening new ones. we saw how to follow interesting projects on GitHub to get notifications. We got a better understanding of the structure of a Github URL, and how to find a git repo of a project. We found out for the first time what are yaml files and other impressive and important things!

Second assignment

I have selected some more interesting projects to follow, among them:
El kantoniko de Ladino en el Internet
Ansible
played around with yaml edited the OSDC course repository, added JSON file, and sent a PR.

OSDC-2023-first-assignment

ranms25 — Thu, 09 Mar 2023 14:23:32 +0000

Today was the first day of the course OSDC 2023, led by @szabgab OSDC.

In the first assignment, I played around with GitHub, edited the OSDC course repository, added JSON file, and sent a pull request.

I am really looking forward to this course and hope to learn new tools in the field of Open Source Development.