chore: release of 0.4.0

Logic-py · web-flow · commit 0a5bc00a5236 · 2024-09-25T23:09:13.000+02:00
Merge pull request #16 from Logic-py/develop
diff --git a/.github/workflows/ci_check_release.yml b/.github/workflows/ci_check_release.yml
@@ -110,9 +110,34 @@ jobs:
         run: |
           poetry run mypy --config-file pyproject.toml .
 
+  test:
+    runs-on: ubuntu-latest
+    needs: setup  # Ensure setup job has succeeded
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Poetry
+        run: |
+          pip install poetry
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Run Unit Tests
+        run: |
+          poetry run pytest
+
   create_release:
     runs-on: ubuntu-latest
-    needs: [ lint, type-check ]  # Ensure lint and type-check jobs have succeeded
+    needs: [ lint, type-check, test ]  # Ensure lint, type-check, and test jobs have succeeded
     if: github.ref == 'refs/heads/main'  # Only run on main branch
 
     steps:
@@ -146,4 +171,4 @@ jobs:
           draft: false
           prerelease: false
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -24,6 +24,7 @@ repos:
         types: [ python ]
         args: [ "--config", "pyproject.toml" ]
         pass_filenames: true
+        exclude: tests
 
       - id: mypy-type-check
         name: Type Checking
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Loïc Motheu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,3 +1,119 @@
-# python-template
+# Python Template
 
-Used to templatize python projects.
+This is a template project for Python, designed to streamline the creation of Python projects using (What I think are)
+best practices.
+
+## Table of Contents
+
+- [Features](#features)
+- [Getting Started](#getting-started)
+- [CI/CD Workflow](#cicd-workflow)
+- [Dependencies](#dependencies)
+- [Code Quality](#code-quality)
+- [Pre-commit Hooks](#pre-commit-hooks)
+- [License](#license)
+
+## Features
+
+- Code formatting and linting using [Ruff](https://ruff.rs).
+- Type checking with [Mypy](https://mypy.readthedocs.io).
+- Pre-commit hooks to maintain code quality.
+
+## Getting Started
+
+Follow these steps to get started with this template:
+
+1. **Clone the repository or use the template directly via GitHub.**
+
+2. **Install Poetry:**
+
+   Ensure you have [Poetry](https://python-poetry.org/) installed. If not, you can install it using:
+   ```bash
+   pip install poetry
+   ```
+   > **Note:** This template is set up using Poetry version 1.8.3.
+
+3. **Install dependencies:**
+
+   ```bash
+   poetry install
+   ```
+
+4. **Ready to Implement:**
+
+   You are now ready to implement your project. Keep in mind that this is a base template and not a fully functioning
+   application.
+
+## CI/CD Workflow
+
+This project includes a continuous integration (CI) workflow that is triggered on every push and pull request, using
+GitHub Actions to run the following jobs:
+
+1. **Setup**: Checks out the code, sets up Python, and installs dependencies using Poetry.
+2. **Format**: Formats the code with Ruff.
+3. **Lint**: Runs linting on the codebase with Ruff.
+4. **Type Check**: Checks for type consistency using Mypy.
+5. **Create Release**: Automatically creates a GitHub release when code is pushed to the main branch.
+
+### Workflow File
+
+The CI workflow is defined in `.github/workflows/ci_check_release.yml`.
+
+## Dependencies
+
+This project includes the following dependencies:
+
+- **Core Dependencies**:
+    - `python`: ^3.12
+    - `loguru`: ^0.7.2
+
+- **Development Dependencies**:
+    - `ruff`: ^0.6.7 (for code linting and formatting)
+    - `mypy`: ^1.11.2 (for type checking)
+    - `pre-commit`: ^3.8.0 (for managing Git hooks)
+    - `pytest`: ^7.2.0 (for unit testing)
+
+## Code Quality
+
+This repository employs several tools to ensure code quality:
+
+- **Ruff**: A fast Python linter and formatter that enforces a consistent style and detects potential errors.
+- **Mypy**: A static type checker for Python that ensures type safety.
+
+## Pre-commit Hooks
+
+To set up pre-commit hooks for automatic formatting and linting on commit, ensure `pre-commit` is installed:
+
+```bash
+poetry install
+```
+
+Then, install the hooks:
+
+```bash
+pre-commit install
+```
+
+Once installed, the hooks will run automatically before each commit.
+
+### Pre-commit Hooks Configuration
+
+This repository uses pre-commit hooks to enforce code quality and standards before committing changes. Here’s an
+overview of the configured hooks:
+
+#### 1. Commitlint Hook
+
+- **Purpose**: Ensures commit messages adhere to defined conventions for consistency and clarity.
+
+#### 2. Local Hooks
+
+- **Ruff Format**: Automatically formats Python code according to specified rules.
+- **Ruff Lint**: Performs linting to catch potential errors and maintain coding standards.
+- **Mypy Type Check**: Checks type annotations for consistency and correctness in Python code.
+- **Pytest**: Runs the tests found in the /tests folder.
+
+For more information on pre-commit, visit [pre-commit.com](https://pre-commit.com).
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-template"
-version = "0.3.4"
+version = "0.4.0"
 description = "Used to templatize python projects."
 authors = ["Loïc Motheu <lmotheu@gmail.com>"]
 readme = "README.md"
@@ -11,9 +11,10 @@ python = "^3.12"
 loguru = "^0.7.2"
 
 [tool.poetry.group.dev.dependencies]
-ruff = "^0.6.7"
 mypy = "^1.11.2"
 pre-commit = "^3.8.0"
+pytest = "^8.3.3"
+ruff = "^0.6.7"
 
 [tool.ruff]
 src = ["src"]
@@ -28,9 +29,10 @@ line-ending = "auto"
 
 [tool.ruff.lint]
 select = ["ALL"]
-ignore = ["D203", "COM812", "ISC001", "D213"]
+ignore = ["D203", "COM812", "ISC001", "D213", "FA102"]
 fixable = ["ALL"]
 unfixable = []
+exclude = ["tests/*"]
 
 [tool.mypy]
 exclude = "tests/*"
diff --git a/src/main.py b/src/main.py
@@ -22,4 +22,4 @@ def example(data: str) -> None:
     a = 5
     b = 1
 
-    example(data="5")
+    example(data=str(a + b))
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/demo_test.py b/tests/demo_test.py
@@ -0,0 +1,28 @@
+"""Demo Unit test Example."""
+
+import pytest
+
+
+def add(a: int | float, b: int | float) -> int | float:
+    return a + b
+
+
+def test_add_positive_numbers():
+    assert add(1, 2) == 3
+
+
+def test_add_negative_numbers():
+    assert add(-1, -1) == -2
+
+
+def test_add_mixed_numbers():
+    assert add(-1, 1) == 0
+
+
+def test_add_zero():
+    assert add(0, 0) == 0
+
+
+# The following is optional, as pytest will automatically find tests.
+if __name__ == "__main__":
+    pytest.main()
