added githu actions CI

Author: andreascaglioni

.github/workflows/tests.yml

@@ -0,0 +1,65 @@
+name: tests
+
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+
+# optional: cancel older runs on the same branch
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pytest:
+    name: Pytest (Linux, Py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests (with coverage)
+        run: |
+          python -m pytest -q --cov=example_lib --cov-report=term --cov-report=html
+
+      - name: Upload HTML coverage
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: htmlcov-${{ matrix.python-version }}
+          path: htmlcov
+          if-no-files-found: ignore
+
+  lint:
+    name: Pre-commit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: pip
+      - name: Install pre-commit
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+      - name: Run pre-commit
+        run: |
+          pre-commit run --all-files || true

.gitignore

@@ -73,5 +73,12 @@ docs/_build/
 # Ignore build artifacts created by editable installs
 *.egg-link
 
+# Ruff
+.ruff_cache/
+
 # Keep track of any project-specific ignores below
 # e.g. experiments/data/, notebooks/data/, etc.
+
+
+# Pytest coverage test report dir
+htmlcov

pyproject.toml

@@ -5,10 +5,11 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "example-lib"
 version = "0.1.0"
-description = "Mini calculator library"
+description = "Mini calculator library showcasing clean code, testing, and packaging."
 readme = "README.md"
 requires-python = ">=3.8"
-authors = [{ name = "Andrea" }]
+authors = [{ name = "Andrea Scaglioni", email = "[email protected]" }]
+keywords = ["example", "template", "project-template", "pytest", "sphinx", "CI/CD"]
 license = { text = "MIT" }
 dependencies = []
 
@@ -18,9 +19,41 @@ classifiers = [
   "Operating System :: OS Independent",
 ]
 
+
+# --- PyTest Options
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "
+-q
+--strict-markers
+--disable-warnings
+--cov=src
+--cov-report=term-missing
+--cov-fail-under=85
+"
+markers = [
+  "integration: marks integration tests (deselect with '-m \"not integration\"')",
+  "slow: marks slow tests",
+]
+
+
+# --- Optional dependencies for development, docs, etc.
 [project.optional-dependencies]
-dev = ["pytest", "pytest-cov"]
+dev = [
+  "pytest",
+  "pytest-cov",
+  "pre-commit",
+  "black",
+  "ruff",
+  "mypy",
+]
+
+docs = [
+  "sphinx>=7.0"
+]
+
 
+# --- SetUpTool options
 [tool.setuptools]
 package-dir = {"" = "src"}