@@ -15,17 +15,18 @@ templates for Python packages?
1515
1616- Lives with the [ Scientific-Python Development Guide] [ ] : Every decision is
1717 clearly documented and every tool described, and everything is kept in sync.
18- - Nine different backends to choose from for building packages.
18+ - Ten different backends to choose from for building packages.
1919- Optional VCS versioning for most backends.
20+ - Selection for your preferred documentation engine (Sphinx or MkDocs).
2021- Template generation tested in GitHub Actions using nox.
2122- Supports generation with [ copier] [ ] , [ cookiecutter] [ ] , and [ cruft] [ ] .
2223- Supports GitHub Actions if targeting a ` github.com ` url (the default), and
2324 adds experimental GitLab CI support otherwise.
2425- Includes several compiled backends using [ pybind11] [ ] , with wheels produced
2526 for all platforms using [ cibuildwheel] [ ] .
2627- Provides [ ` sp-repo-review ` ] [ pypi-link ] to evaluate existing repos against the
27- guidelines, with a WebAssembly version integrated with the guide. All checks
28- cross-linked .
28+ guidelines, with a WebAssembly version integrated with the guide. Checks are
29+ hyperlinked back to the guide .
2930- Follows [ PyPA] [ ] best practices and regularly updated. Recent additions:
3031 - [ PEP 639] ( https://peps.python.org/pep-0639 ) : SPDX licenses
3132 - [ PEP 735] ( https://peps.python.org/pep-0735 ) : Dependency groups
@@ -134,22 +135,28 @@ backports structure with a small typing example.
134135- GitHub Actions runs testing for the generation itself
135136 - Uses nox so cookie development can be checked locally
136137 - Uses uv for high performance CI
137- - GitHub actions deploy
138+ - GitHub actions deployment
138139 - C++ backends include cibuildwheel for wheel builds
139140 - Uses PyPI trusted publisher deployment
141+ - A GitHub release configuration that skips common bot commits when
142+ auto-generating release notes
140143- Dependabot keeps actions up to date periodically, through useful pull requests
141- - Formatting handled by pre-commit
144+ - A contributing guide
145+ - Formatting handled by pre-commit or prek
142146 - No reason not to be strict on a new project; remove what you don't want.
143147 - Includes MyPy - static typing
144148 - Includes Ruff - standard formatting, linting and autofixes
145149 - Replaces Flake8, isort, pyupgrade, yesqa, pycln, and dozens of plugins
146150 - Includes spell checking
151+ - One of several popular licenses
147152- An pylint nox target can be used to run pylint, which integrated GHA
148153 annotations
149- - A ReadTheDocs-ready Sphinx docs folder and ` docs ` dependency-group
150- - A test folder and pytest ` test ` dependency-group
154+ - A ReadTheDocs-ready Sphinx or MkDocs ` docs/ ` folder and ` docs `
155+ dependency-group
156+ - A ` tests/ ` folder and pytest ` test ` dependency-group
151157- A dev group for ` uv run ` integration
152158- A noxfile is included with a few common targets
159+ - A README
153160
154161#### For developers:
155162
0 commit comments