drop support for Python 3.9, update dependencies and docs

Author: mariushelf

.github/workflows/cicd.yaml

@@ -12,12 +12,10 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"
-          - "pypy-3.9"
           - "pypy-3.10"
     steps:
     - uses: actions/checkout@v3

cookiecutter.json

@@ -1,10 +1,10 @@
 {
   "author_name": "Joe Doe",
   "author_email": "joe@example.com",
-  "github_username": "joesgithub",
-  "project_name": "Python Boilerplate",
-  "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
-  "project_short_description": "Python Boilerplate contains all the boilerplate you need to create a Python package.",
+  "github_username": "{{ cookiecutter.author_name.lower().replace(' ', '') }}",
+  "project_name": "{{ cookiecutter.author_name }}'s new project",
+  "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_').replace('.', '_').replace('\\'', '') }}",
+  "project_short_description": "{{ cookiecutter.project_name }} is a Python project.",
   "version": "0.1.0",
   "license": [
     "MIT",

{{ cookiecutter.project_slug }}/.github/workflows/cicd.yaml

@@ -13,7 +13,6 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
@@ -36,12 +35,10 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
           - "3.13"
-          - "pypy-3.9"
           - "pypy-3.10"
     steps:
       - uses: actions/checkout@v3

{{ cookiecutter.project_slug }}/.pre-commit-config.yaml

@@ -2,24 +2,24 @@ minimum_pre_commit_version: "3.0"
 repos:
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: 'v0.8.2'
+  rev: 'v0.9.10'
   hooks:
   - id: ruff
     args: [--fix, --exit-non-zero-on-fix]
   - id: ruff-format
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.22.0
+  rev: 0.31.3
   hooks:
   - id: check-gitlab-ci
     files: .gitlab-ci.yml
 - repo: https://github.com/adrienverge/yamllint.git
-  rev: v1.29.0
+  rev: v1.35.1
   hooks:
   - id: yamllint
     args: [-d relaxed]
     verbose: true
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.13.0
+  rev: v1.15.0
   hooks:
   - id: mypy
     # for args see https://mypy.readthedocs.io/en/stable/command_line.html

{{ cookiecutter.project_slug }}/.readthedocs.yaml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: "ubuntu-22.04"
   tools:
-    python: "3.9"
+    python: "3.10"
   jobs:
     post_create_environment:
     # Install poetry

{{ cookiecutter.project_slug }}/README.md

@@ -120,43 +120,6 @@ E.g., for version `1.2.3` the tag must be `1.2.3`.
    publishes the package to
    [PyPI](https://pypi.org/project/{{ cookiecutter.project_slug }}/).
 
-## Upload from the local machine (not recommended)
-
-[twine](https://twine.readthedocs.io/en/stable/) allows to upload a package
-from your local machine to PyPI.
-
-### Prerequisites
-
-You need a PyPI API token. See prerequisites for the Github actions above
-(you don't need to perform any actions on Github when using twine, so you
-only need to perform step 1).
-
-### Configuration
-
-The PyPI credentials must be configured either via a configuration file
-or via environment variables.
-See the [twine documentation](https://twine.readthedocs.io/en/stable/#configuration)
-for details.
-
-Since we are using an api token to authenticate with PyPI, the username
-must be set to `__token__`, and the password is the actual token.
-
-When using the PyPI test server, the repository url must be set to
-`https://test.pypi.org/legacy/`.
-
-### Usage
-
-The `publish` target in the [Makefile](Makefile) calls twine to upload
-a package to PyPI.
-
-**Note:** the upload command is deactivated by default to prevent accidental
-uploads. You need to manually uncomment it before the first release.
-
-Here are the necessary steps:
-
-1. update the version number in the [pyproject.toml](pyproject.toml)
-2. run `make publish`.
-
 
 # Using a custom package repository
 
@@ -172,27 +135,6 @@ To release to a server other than the standard PyPI, you need to specify the res
 repository URL when uploading.
 
 
-### Releasing to a custom repo with twine
-
-With twine, you can specify the repository URL via the `--repository-url` parameter.
-
-In the special case of the PyPI Test server, you can also specify
-`--repository testpypi`.
-
-```bash
-# for Test PyPI
-twine upload --repository testpypi dist/*
-
-# for any custom repository
-twine upload --repository-url <URL> dist/*
-```
-
-In the context of this project, you can modify the `publish` target in the
-[Makefile](Makefile).
-
-See also [Using TestPyPI](https://packaging.python.org/en/latest/guides/using-testpypi/).
-
-
 ### Releasing to a custom repo with Github actions
 
 To release to a custom repo with Github actions, you can follow the same process
@@ -210,7 +152,8 @@ as described above for the default PyPI. The only necessary change is adding a
     repository_url: https://test.pypi.org/legacy/
 ```
 
-For use with Test PyPI you need an account and an API token from [test.pypi.org](https://test.pypi.org). Note that in the example above, that token is assumed to
+For use with Test PyPI you need an account and an API token from [test.pypi.org](https://test.pypi.org). 
+Note that in the example above, that token is assumed to
 be stored in the `TEST_PYPI_API_TOKEN` secret in Github.
 
 See also [Advanced release management](https://github.com/marketplace/actions/pypi-publish#advanced-release-management)

{{ cookiecutter.project_slug }}/pyproject.toml

@@ -10,7 +10,6 @@ repository = "https://github.com/{{cookiecutter.github_username}}/{{cookiecutter
 documentation = "https://{{ cookiecutter.project_slug }}.readthedocs.io"
 classifiers = [
     "Development Status :: 4 - Beta",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -20,7 +19,7 @@ classifiers = [
 
 # Only packages in this group will be installed in the release image
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 pydantic = "^2.0.0"
 pydantic-settings = "^2.0.0"
 
@@ -30,22 +29,18 @@ pydantic-settings = "^2.0.0"
 # but are installed by poetry by default.
 # So they are available in your dev environment,
 # but not in a production environment.
-# myst-nb = "^0.16.0"  # useful, but depends on really old version of sphinx
-myst-parser = "^1.0.0"
-Sphinx = "^6.1.3"
-sphinx-autobuild = "^2021.3.14"
-sphinx-rtd-theme = "^1.2.0"
-sphinxcontrib-mermaid = "^0.7.1"
+myst-parser = "^4.0.0"
+Sphinx = "^7.0.0|^8.0.0"
+sphinx-autobuild = "^2024.10.3"
+sphinx-rtd-theme = "^3.0.0"
+sphinxcontrib-mermaid = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]
-pre-commit = "^3.0"
-pytest = "^7.2.2"
-pytest-cov = "^4.0.0"
+pre-commit = "^4.0.0"
+pytest = "^8.0.0"
+pytest-cov = "^6.0.0"
 tox = "^4.0.0"
 
-# deployment
-twine = "^4.0.2"
-
 [tool.ruff.lint]
 select = [
     "ANN",  # flake8-annotations

{{ cookiecutter.project_slug }}/tests/test_{{ cookiecutter.project_slug }}.py

@@ -7,13 +7,15 @@
 
 def test_reminder():
     """Reminder to write tests."""
-    assert False, "If this test runs it probably means that you have not written your own tests yet 😱 Do it now!"
+    assert False, (
+        "If this test runs it probably means that you have not written your own tests yet 😱 Do it now!"
+    )
 
 
 def test_version_is_semver_string():
     """Test that the version in pyproject.toml is a proper semantic version."""
     semver_pattern = r"^(?P<major>0|[1-9]\d*)\.(?P<minor>0|[1-9]\d*)\.(?P<patch>0|[1-9]\d*)(?:-(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?P<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$"
     version = {{ cookiecutter.project_slug }}.__version__
-    assert re.match(
-        semver_pattern, version
-    ), f'"{version}" is not a valid semver version'
+    assert re.match(semver_pattern, version), (
+        f'"{version}" is not a valid semver version'
+    )

{{ cookiecutter.project_slug }}/tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py39,py310,py311,py312,py313,pypy39,pypy310
+envlist = py310,py311,py312,py313,pypy310
 isolated_build = True
 parallel = True
 
@@ -13,10 +13,8 @@ commands =
 
 [gh-actions]
 python =
-    3.9: py39
     3.10: py310
     3.11: py311
     3.12: py312
     3.13: py313
-    pypy-3.9: pypy39
     pypy-3.10: pypy310