@@ -8,19 +8,21 @@ A modern Python project template using recommended development tools and best pr
88
99## Features
1010
11- This template provides a comprehensive set of tools to streamline your Python development workflow:
11+ This template uses the best development tools while staying simple and uncluttered.
12+ Everything is designed to be opt-in, so you can use only what you need and ignore the rest until necessary.
13+ Sensible defaults for all included tools are provided.
1214
1315### Code Structure
1416
15- - Modern project layout following best practices
17+ - Follows modern project layout following best practices
1618- Optional: Command-line interface with [ Typer] ( https://typer.tiangolo.com/ )
1719- Optional: Easy logging with [ Loguru] ( https://loguru.readthedocs.io/ )
1820
1921### Development Tools
2022
21- - Python dependency management with [ uv] ( https://docs.astral.sh/uv/ ) (faster alternative to pip/poetry)
22- - Versioning management with [ uv-dynamic-versioning] ( https://github.com/ninoseki/uv-dynamic-versioning )
2323- Task automation with [ Just] ( https://just.systems/man/en/ ) command runner
24+ - Python dependency management with [ uv] ( https://docs.astral.sh/uv/ ) (faster alternative to pip/poetry)
25+ - Optional: Versioning management with [ uv-dynamic-versioning] ( https://github.com/ninoseki/uv-dynamic-versioning )
2426
2527### Code Quality
2628
@@ -29,23 +31,24 @@ This template provides a comprehensive set of tools to streamline your Python de
2931 - Performance benchmarking with [ pytest-benchmark] ( https://pytest-benchmark.readthedocs.io/ )
3032 - Additional pytest plugins for a better testing experience
3133- Code formatting with [ Black] ( https://black.readthedocs.io/ ) or [ Ruff formatter] ( https://docs.astral.sh/ruff/formatter/ )
32- - Markdown formatting with [ Mdformat ] ( https://mdformat.readthedocs.io / )
34+ - Documentation formatting with [ blacken-docs ] ( https://github.com/adamchainz/blacken-docs / )
3335- Comprehensive linting with [ Ruff] ( https://docs.astral.sh/ruff/ )
3436 - Replaces Flake8, isort, pyupgrade, yesqa, pycln, and dozens of plugins
3537- Static type checking with [ MyPy] ( https://mypy-lang.org/ )
36- - Spell checking with [ codespell] ( https://github.com/codespell-project/codespell/yyzz ) and [ typos] ( https://github.com/crate-ci/typos/ )
38+ - Curated ` .gitignore ` file
39+ - Formatting and linting run automatically on commit via [ pre-commit] ( https://pre-commit.com/ ) hooks:
40+ - [ EditorConfig] ( https://editorconfig.org/ ) for consistent formatting across editors
41+ - Spell checking with [ codespell] ( https://github.com/codespell-project/codespell ) and [ typos] ( https://github.com/crate-ci/typos )
42+ - Markdown formatting with [ Mdformat] ( https://mdformat.readthedocs.io/ )
43+ - Validation for JSON, TOML, XML, and YAML files
44+ - Linting for YAML, reStructuredText, and shell scripts
45+ - Schema checking for ` pyproject.toml ` and GitHub configuration files
3746
3847### CI/CD Integration
3948
40- - Git hooks via [ pre-commit] ( https://pre-commit.com/ ) with many hooks pre-configured
4149- Test automation with [ GitHub Actions] ( https://docs.github.com/en/actions )
4250- Dependency updates with [ Dependabot] ( https://docs.github.com/en/code-security/dependabot )
4351
44- ### Configuration Files
45-
46- - [ EditorConfig] ( https://editorconfig.org/ ) for consistent formatting across editors
47- - Comprehensive [ .gitignore] ( https://gitignore.io/ ) file
48- - Sensible defaults for all included tools
4952
5053### Documentation (Coming Soon)
5154
0 commit comments