https://github.com/daxartio/python-project-template
A template Python project with a focus on best practices
https://github.com/daxartio/python-project-template
cookiecutter cookiecutter-template mkdocs pyo3 python python-template template
Last synced: 15 days ago
JSON representation
A template Python project with a focus on best practices
- Host: GitHub
- URL: https://github.com/daxartio/python-project-template
- Owner: daxartio
- License: mit
- Created: 2020-10-29T19:24:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-11T06:23:22.000Z (6 months ago)
- Last Synced: 2025-03-28T20:11:12.369Z (about 1 month ago)
- Topics: cookiecutter, cookiecutter-template, mkdocs, pyo3, python, python-template, template
- Language: Makefile
- Homepage:
- Size: 89.8 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Project Template
## Features
- [x] MIT/Apache License
- [x] Makefile
- [x] [uv](https://docs.astral.sh/uv/)
- [x] Formatting
- [x] ruff
- [x] Linters
- [x] ruff
- [x] mypy
- [x] Pytest
- [x] Documentation with [mkdocs](https://www.mkdocs.org/)
- [x] Github Actions
- [x] Github pages
- [x] Publish to pypi
- [x] Run tests and linters
- [x] Bump a version
- [x] Check a PR title
- [ ] CLI
- [x] [argparse](https://docs.python.org/3/howto/argparse.html)
## Quickstart
Install the latest Cookiecutter
```
pip install -U cookiecutter
```
Generate a Python project:
```
cookiecutter https://github.com/daxartio/python-project-template.git
```
Then:
```bash
cd ./your-project
make install
make format lint test
```
1. Generate an API token, see https://pypi.org/help/
2. Add the token to https://github.com/username/your-project/settings/secrets/actions
- PYPI_USERNAME `__token__`
- PYPI_PASSWORD `pypi-...`
3. Workflow permissions https://github.com/username/your-project/settings/actions
1. Set "Read and write permissions" to true