Run black formatting

Author: andreascaglioni

.github/workflows/tests.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Run tests (with coverage)
         run: |
-          python -m pytest -q --cov=example_lib --cov-report=term --cov-report=html
+          python -m pytest -q --cov=python_project_template --cov-report=term --cov-report=html
 
       - name: Upload HTML coverage
         if: always()

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project are recorded here.
 ## [Unreleased]
 
 ### Added
-- Mini calculator library (`example_lib`) with:
+- python project template (`python-project-template`) with:
 	- `Operation`, `OperationRegistry`, and `Calculator` classes
 	- example operations: `add`, `sub`, `mul`, `div`, `neg`, `sqr`
 - Minimal test suite (pytest) with unit and edge tests

pyproject.toml

@@ -3,9 +3,9 @@ requires = ["setuptools>=61", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "example-lib"
+name = "python-project-template"
+description = "A minimal Python project demonstrating best practices for testing, documentation, and CI/CD. It implements a mini calculator as a minimal example."
 version = "0.1.0"
-description = "Mini calculator library showcasing clean code, testing, and packaging."
 readme = "README.md"
 requires-python = ">=3.8"
 authors = [{ name = "Andrea Scaglioni", email = "[email protected]" }]
@@ -22,14 +22,7 @@ classifiers = [
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-addopts = [
-  "-q",
-  "--strict-markers",
-  "--disable-warnings",
-  "--cov=src",
-  "--cov-report=term-missing",
-  "--cov-fail-under=85",
-]
+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",
@@ -48,7 +41,9 @@ dev = [
 ]
 
 docs = [
-  "sphinx>=7.0"
+  "sphinx>=7.0",
+  "pydata-sphinx-theme",
+  "sphinx-autodoc-typehints",
 ]
 
 
@@ -58,4 +53,4 @@ package-dir = {"" = "src"}
 
 [tool.setuptools.packages.find]
 where = ["src"]
-include = ["example_lib*"]
+include = ["python_project_template*"]

src/example_lib/__init__.py src/python_project_template/__init__.pysrc/example_lib/__init__.py renamed to src/python_project_template/__init__.py

@@ -1,4 +1,4 @@
-"""example_lib: mini math utility library
+"""python-project-template: mini math utility library
 
 Exports:
 - Operation, Operation registry, Calculator, convenience operations

src/example_lib/calculator.py src/python_project_template/calculator.pysrc/example_lib/calculator.py renamed to src/python_project_template/calculator.py

@@ -1,6 +1,6 @@
 import pytest
 
-from example_lib import default_calculator
+from python_project_template import default_calculator
 
 
 @pytest.fixture(scope="session")