feat: version and description of generated project is dynamic field of pyproject.toml

Author: liborjelinek

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+
+- Version and description of generated project is dynamic field of pyproject.toml
+
 ## [0.2.0] - 2025-03-26
 
 ### Added

template/pyproject.toml.copier

@@ -1,8 +1,7 @@
 [project]
 name = "{{ project_slug }}"
-version = "0.1.0"
 readme = "README.md"
-description = "{{ description }}"
+dynamic = ["version", "description"]
 dependencies = [
     "beautifulsoup4>=4.13.3",
     "sphinx>=8.0",
@@ -36,5 +35,5 @@ dev = [
 sample-docs = { path = "{{ sample_docs_slug }}", editable = true }
 
 [build-system]
-requires = ["flit_core >=3.2,<4"]
+requires = ["flit_core >=3.12,<4"]
 build-backend = "flit_core.buildapi"

template/src/{{ project_slug }}/__init__.py.copier

@@ -1,17 +1,25 @@
 """
-Register theme with Sphinx.
+{{ description }}
 """
 
+__version__ = "0.1.0"
+
+
 from pathlib import Path
 
 from sphinx.application import Sphinx
+from sphinx.util.typing import ExtensionMetadata
 
 THEME_NAME = "{{ project_slug }}"
 
 
-def setup(app: Sphinx) -> dict[str, bool]:
+def setup(app: Sphinx) -> ExtensionMetadata:
     """Setup the Sphinx application."""
     theme_path = str(Path(__file__).parent.resolve())
     app.add_html_theme(THEME_NAME, theme_path)
 
-    return {"parallel_read_safe": True, "parallel_write_safe": True}
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+        "version": __version__,
+    }

tests/test_bake/defaults/pyproject.toml

@@ -1,8 +1,7 @@
 [project]
 name = "sphinx_foo_theme"
-version = "0.1.0"
 readme = "README.md"
-description = "Foo but full-bar theme."
+dynamic = ["version", "description"]
 dependencies = [
     "beautifulsoup4>=4.13.3",
     "sphinx>=8.0",
@@ -36,5 +35,5 @@ dev = [
 sample-docs = { path = "sample_docs", editable = true }
 
 [build-system]
-requires = ["flit_core >=3.2,<4"]
+requires = ["flit_core >=3.12,<4"]
 build-backend = "flit_core.buildapi"

tests/test_bake/defaults/src/sphinx_foo_theme/__init__.py

@@ -1,17 +1,25 @@
 """
-Register theme with Sphinx.
+Foo but full-bar theme.
 """
 
+__version__ = "0.1.0"
+
+
 from pathlib import Path
 
 from sphinx.application import Sphinx
+from sphinx.util.typing import ExtensionMetadata
 
 THEME_NAME = "sphinx_foo_theme"
 
 
-def setup(app: Sphinx) -> dict[str, bool]:
+def setup(app: Sphinx) -> ExtensionMetadata:
     """Setup the Sphinx application."""
     theme_path = str(Path(__file__).parent.resolve())
     app.add_html_theme(THEME_NAME, theme_path)
 
-    return {"parallel_read_safe": True, "parallel_write_safe": True}
+    return {
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+        "version": __version__,
+    }