Merge remote-tracking branch 'upstream/main' into ex1

Author: zG4bry

.github/workflows/ci.yml .github/workflows/lint.yml.github/workflows/ci.yml renamed to .github/workflows/lint.yml

@@ -13,15 +13,15 @@ on:
       - "docs/**"
 
 jobs:
-  test:
+  lint:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v6
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v6
         with:
-          python-version: "3.10"
+          python-version: "3.14"
       - name: Install dependencies for requirements and testing
         run: |
           python -m pip install --upgrade pip
@@ -41,5 +41,8 @@ jobs:
       - name: Lint with mypy
         run: mypy $(git ls-files '*.py')
 
-      # - name: Test with pytest
-      #   run: pytest --cov src tests/
+      - name: Check code formatting with black
+        run: black --check --diff $(git ls-files '*.py')
+
+      - name: Check code formatting with isort
+        run: isort --check-only --diff $(git ls-files '*.py')

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "README.md"
+      - "docs/**"
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - "README.md"
+      - "docs/**"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python 3.14
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+      - name: Install dependencies for requirements and testing
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          if [ -f requirements_dev.txt ]; then pip install -r requirements_dev.txt; fi
+
+      - name: Test with pytest
+        run: pytest --cov src tests/

.gitignore

@@ -2,3 +2,4 @@
 **/*.pyc
 **/.DS_Store
 .coverage
+venv/

.pylintrc

@@ -89,10 +89,6 @@ py-version=3.10
 # Discover python modules and packages in the file system subtree.
 recursive=no
 
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no
@@ -307,8 +303,8 @@ min-public-methods=2
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when caught.
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception
 
 
 [FORMAT]

README.md

@@ -2,31 +2,44 @@
 
 This repository has been created to give a python template project which includes pytest instructions.
 
-### Install requirements
+### 1️⃣ How to start (one-time step)
 
-Use pip or pip3 to install the dev requirements for the software testing:
+Fork this repository and clone your fork into your machine using:
 
 ```bash
-pip install -r requirements_dev.txt
+git clone git@github.com:USERNAME/qd-starter-pack.git
 ```
 
-### 1️⃣ How to start
+enter to your project directory using:
 
-Fork this repository and clone your fork into your machine using:
 ```bash
-git clone git@github.com:USERNAME/qd-starter-pack.git
+cd qd-starter-pack
 ```
 
-enter to your project directory using:
+Setup virtualenv:
+
 ```bash
-cd qd-starter-pack
+python3 -m pip install venv
+python3 -m venv venv
+source ./venv/bin/activate
 ```
 
+After running these commands you'll see a `(venv)` in your terminal, if so, you are running the python version of the local environment.
+
+Then, install the tests requirements in your local virtual environment
+
+```bash
+pip install -r requirements_dev.txt
+```
+
+⚠️ Note: You need to run `source ./venv/bin/activate` every time you open a new terminal to activate the local virtual environment.
+
 ---
 
 ### 2️⃣ How to make a branch
 
 To create a new `branch` from the main repository and work on a specific exercise (ex. `ex1.py`) you can use the following commands:
+
 ```bash
 git checkout main
 
@@ -38,38 +51,44 @@ git checkout -b new-branch-name
 ### 3️⃣ How to make a commit
 
 From this step you can edit your `ex1.py` and make some commits using:
+
 ```bash
-git add exercises/ex1.py
+git add src/ex1.py
 
 git commit -m 'feat: description'
 ```
+
 Use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) when you write a commit description.
 
 ---
 
 ### 4️⃣ How to make a PR
 
 Push the commits into GitHub using:
+
 ```bash
 git push -u origin new-branch-name
 ```
 
-Afterward, it is possible to create a Pull Request by going to your fork `https://github.com/USERNAME/git-course-exercises.git` clicking on "create Pull Request" or going to the right section "Pull Request" -> "New Pull Request".
+Afterward, it is possible to create a Pull Request by going to your fork `https://github.com/USERNAME/qd-starter-pack.git` clicking on "create Pull Request" or going to the right section "Pull Request" -> "New Pull Request".
 
 If you want to work on another `ex1.py`, go to step 2️⃣.
 
 ---
 
 Use git wisely.
 
-
-<!-- ### Software Testing
+### Software Testing
 
 How to run properly the tests with the related html report:
 
 ```bash
 $ pytest --cov src tests/ --cov-report=html
-``` -->
+
+# or
+
+$ pytest .
+```
 
 ### Clean code
 

requirements_dev.txt

@@ -4,3 +4,5 @@ pytest-cov
 pylint
 mypy
 flake8
+black
+isort

src/sum.py

@@ -1,2 +1,6 @@
 def sum(a: int, b: int) -> int:
     return a + b
+
+
+if __name__ == "__main__":  # pragma: no cover
+    print(sum(3, 5))