Upgrade to scaffops/python@cd034ea

Skeleton revision: https://github.com/bswck/skeleton/tree/cd034ea

.copier-answers.yml

@@ -1,4 +1,4 @@
-_commit: '9815413'
+_commit: cd034ea
 _src_path: gh:bswck/skeleton
 author_username: bswck
 docs: true

.github/FUNDING.yml

@@ -1,2 +1 @@
-github: "bswck"
-custom: "https://www.paypal.me/bswck"
+github: "bswck"

.github/workflows/lint.yml

@@ -5,15 +5,12 @@ on: ["push"]
 jobs:
   lint:
     runs-on: "ubuntu-latest"
-    strategy:
-      matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
     - uses: "actions/checkout@v4"
-    - name: "Set up Python ${{matrix.python-version}}"
-      uses: "actions/setup-python@v3"
+    - name: "Set up Python 3.8"
+      uses: "actions/setup-python@v4"
       with:
-        python-version: "${{matrix.python-version}}"
+        python-version: "3.8"
     - name: "Install Ruff"
       run: |
         pipx install ruff

.github/workflows/mypy.yml

@@ -5,15 +5,12 @@ on: ["push"]
 jobs:
   typecheck:
     runs-on: "ubuntu-latest"
-    strategy:
-      matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
     - uses: "actions/checkout@v4"
-    - name: "Set up Python ${{matrix.python-version}}"
-      uses: "actions/setup-python@v3"
+    - name: "Set up Python 3.8"
+      uses: "actions/setup-python@v5"
       with:
-        python-version: "${{matrix.python-version}}"
+        python-version: "3.8"
     - name: "Install the project"
       run: |
         pipx install poetry

.github/workflows/smokeshow.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: "ubuntu-latest"
     environment: "Smokeshow"
     steps:
-    - uses: "actions/setup-python@v4"
+    - uses: "actions/setup-python@v5"
       with:
         python-version: "3.8"
     - run: "pip install smokeshow"

.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
     - uses: "actions/checkout@v4"
     - name: "Set up Python ${{matrix.python-version}}"
-      uses: "actions/setup-python@v3"
+      uses: "actions/setup-python@v5"
       with:
         python-version: "${{matrix.python-version}}"
     - name: "Install the project"

.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# VSCode workspace files
+*.code-workspace

CHANGELOG.md

@@ -5,4 +5,5 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).<br/>
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-<!-- insertion marker -->
+<!-- insertion marker -->
+

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Contributing to [runtime_generics](https://github.com/bswck/runtime_generics) 🎉
 Contributions are very welcome. 🚀
 
-There are many ways to contribute, ranging from **writing tutorials and improving the documentation**, to **submitting bug reports and feature requests or writing code** which can be **incorporated into runtime_generics**.
+There are many ways to contribute, ranging from **writing tutorials and improving the documentation**, to **submitting bug reports and feature requests** or **writing code** which can be incorporated into runtime_generics.
 
 ## Report bugs and request features 🐛
 Report these in the [issue tracker](https://github.com/bswck/runtime_generics/issues).
@@ -40,6 +40,7 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
 
 1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
     Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
+    You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
 
     ```shell
     pipx install poetry
@@ -60,6 +61,11 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
     cd path/to/runtime_generics
     poetry env use $(cat .python-version)
     poetry install
+    ```
+
+    Next up, simply activate the virtual environment and install pre-commit hooks:
+
+    ```shell
     poetry shell
     pre-commit install --hook-type pre-commit --hook-type pre-push
     ```
@@ -92,6 +98,9 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
 
 ## Pull Request guidelines 📝
 1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
-2. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
-3. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
-4. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.
+
+1. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
+
+1. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
+
+1. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.

README.md

@@ -2,6 +2,7 @@
 # runtime_generics [![Package version](https://img.shields.io/pypi/v/runtime-generics?label=PyPI)](https://pypi.org/project/runtime-generics/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/runtime-generics.svg?logo=python&label=Python)](https://pypi.org/project/runtime-generics/)
 [![Tests](https://github.com/bswck/runtime_generics/actions/workflows/test.yml/badge.svg)](https://github.com/bswck/runtime_generics/actions/workflows/test.yml)
 [![Coverage](https://coverage-badge.samuelcolvin.workers.dev/bswck/runtime_generics.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg?label=Code%20style)](https://github.com/psf/black)
 [![License](https://img.shields.io/github/license/bswck/runtime_generics.svg?label=License)](https://github.com/bswck/runtime_generics/blob/HEAD/LICENSE)
@@ -97,6 +98,7 @@ poetry add runtime-generics
 
 1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
     Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
+    You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
 
     ```shell
     pipx install poetry
@@ -117,6 +119,11 @@ poetry add runtime-generics
     cd path/to/runtime_generics
     poetry env use $(cat .python-version)
     poetry install
+    ```
+
+    Next up, simply activate the virtual environment and install pre-commit hooks:
+
+    ```shell
     poetry shell
     pre-commit install --hook-type pre-commit --hook-type pre-push
     ```

changes/.gitignore

@@ -0,0 +1 @@
+!.gitignore

docs/contributing.md

@@ -2,7 +2,7 @@
 # Contributing to [runtime_generics](https://github.com/bswck/runtime_generics) 🎉
 Contributions are very welcome. 🚀
 
-There are many ways to contribute, ranging from **writing tutorials and improving the documentation**, to **submitting bug reports and feature requests or writing code** which can be **incorporated into runtime_generics**.
+There are many ways to contribute, ranging from **writing tutorials and improving the documentation**, to **submitting bug reports and feature requests** or **writing code** which can be incorporated into runtime_generics.
 
 ## Report bugs and request features 🐛
 Report these in the [issue tracker](https://github.com/bswck/runtime_generics/issues).
@@ -41,6 +41,7 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
 
 1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
     Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
+    You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
 
     ```shell
     pipx install poetry
@@ -61,6 +62,11 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
     cd path/to/runtime_generics
     poetry env use $(cat .python-version)
     poetry install
+    ```
+
+    Next up, simply activate the virtual environment and install pre-commit hooks:
+
+    ```shell
     poetry shell
     pre-commit install --hook-type pre-commit --hook-type pre-push
     ```
@@ -93,6 +99,9 @@ Ready to contribute? Here's a quick guide on how to set up runtime_generics and
 
 ## Pull Request guidelines 📝
 1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.
-2. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
-3. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
-4. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.
+
+1. Ensure that the [test coverage](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics) is not decreased. If you add a new feature, please add tests for it. [Read more about coverage](https://coverage.readthedocs.io/en/latest/index.html).
+
+1. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.
+
+1. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.

docs/index.md

@@ -2,6 +2,7 @@
 # runtime_generics [![Package version](https://img.shields.io/pypi/v/runtime-generics?label=PyPI)](https://pypi.org/project/runtime-generics/) [![Supported Python versions](https://img.shields.io/pypi/pyversions/runtime-generics.svg?logo=python&label=Python)](https://pypi.org/project/runtime-generics/)
 [![Tests](https://github.com/bswck/runtime_generics/actions/workflows/test.yml/badge.svg)](https://github.com/bswck/runtime_generics/actions/workflows/test.yml)
 [![Coverage](https://coverage-badge.samuelcolvin.workers.dev/bswck/runtime_generics.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/runtime_generics)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Code style](https://img.shields.io/badge/code%20style-black-000000.svg?label=Code%20style)](https://github.com/psf/black)
 [![License](https://img.shields.io/github/license/bswck/runtime_generics.svg?label=License)](https://github.com/bswck/runtime_generics/blob/HEAD/LICENSE)
@@ -39,6 +40,7 @@ poetry add runtime-generics
 
 1.  [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
     Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
+    You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
 
     ```shell
     pipx install poetry
@@ -59,6 +61,11 @@ poetry add runtime-generics
     cd path/to/runtime_generics
     poetry env use $(cat .python-version)
     poetry install
+    ```
+
+    Next up, simply activate the virtual environment and install pre-commit hooks:
+
+    ```shell
     poetry shell
     pre-commit install --hook-type pre-commit --hook-type pre-push
     ```

pyproject.toml

@@ -21,6 +21,7 @@ python = "^3.8"
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.7.0"
 ruff = "^0.1.2"
+towncrier = "^23.11.0"
 pytest = "^7.4.3"
 coverage = "^7.3.2"
 poethepoet = "^0.24.3"
@@ -44,10 +45,34 @@ bump = "scripts/bump.sh"
 check = [
     { ref="test" },
     { ref="lint" },
-    { ref="lock" }
+    { ref="lock" },
 ]
 release.script = "scripts.release:main"
 
+[tool.poe.tasks.added]
+shell = "towncrier create $TICKET.added.md --edit"
+args = [{name = "TICKET", positional = true}]
+
+[tool.poe.tasks.changed]
+shell = "towncrier create $TICKET.changed.md --edit"
+args = [{name = "TICKET", positional = true}]
+
+[tool.poe.tasks.fixed]
+shell = "towncrier create $TICKET.fixed.md --edit"
+args = [{name = "TICKET", positional = true}]
+
+[tool.poe.tasks.deprecated]
+shell = "towncrier create $TICKET.deprecated.md --edit"
+args = [{name = "TICKET", positional = true}]
+
+[tool.poe.tasks.removed]
+shell = "towncrier create $TICKET.removed.md --edit"
+args = [{name = "TICKET", positional = true}]
+
+[tool.poe.tasks.security]
+shell = "towncrier create $TICKET.security.md --edit"
+args = [{name = "TICKET", positional = true}]
+
 [tool.ruff]
 exclude = ["tests/", "scripts/"]
 # To discuss the presented rationales, contact the author (bswck).
@@ -88,6 +113,45 @@ strict = true
 [tool.isort]
 profile = "black"
 
+[tool.towncrier]
+directory = "changes"
+package = "runtime_generics"
+filename = "CHANGELOG.md"
+start_string = "<!-- insertion marker -->\n"
+underlines = ["", "", ""]  # We use Markdown
+title_format = "## [{version}](https://github.com/bswck/runtime_generics/tree/{version}) – {project_date}"
+issue_format = "[#{issue}](https://github.com/bswck/runtime_generics/issues/{issue})"
+
+[[tool.towncrier.type]]
+directory = "security"
+name = "Security"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removed"
+name = "Removed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "deprecated"
+name = "Deprecated"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
 [tool.coverage.report]
 omit = ["tests/*"]
 # fail_under = 96