https://github.com/followtheprocess/python-package-template
A modern template for python package development
https://github.com/followtheprocess/python-package-template
Last synced: 4 months ago
JSON representation
A modern template for python package development
- Host: GitHub
- URL: https://github.com/followtheprocess/python-package-template
- Owner: FollowTheProcess
- License: mit
- Created: 2024-08-26T10:59:31.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-24T09:41:26.000Z (4 months ago)
- Last Synced: 2025-02-24T10:35:08.000Z (4 months ago)
- Language: Jinja
- Size: 118 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Package Template
A modern template for python package development 🚀
## Features
### [uv]
`uv` now supports being a full python package project management tool!
- `uv run pytest`
- `uv sync`
### [GitHub Actions]
The project template comes with a great default GitHub Actions CI/CD pipeline:
- 🧪 Unit testing with [pytest]
- ✅ Linting and formatting with [ruff]
- 📦 Packaging and publishing to PyPI with [OIDC]
### Great Docs
Production ready docs with [mkdocs], [mkdocs-material] and [GitHub Pages]
> [!TIP]
> The docs will be built and deployed to GitHub Pages on every release, or do it manually at any time with `mkdocs gh-deploy`
## Usage
- Ensure you have [copier] installed:
```shell
uv tool install copier
```
- Call copier with this template and answer all the questions
```shell
copier copy gh:FollowTheProcess/python-package-template ./path/to/new/project
```
- Create a new virtual environment with `task dev` and start developing!
[uv]: https://docs.astral.sh/uv/
[GitHub actions]: https://docs.github.com/en/free-pro-team@latest/actions
[pytest]: https://docs.pytest.org/en/stable/
[ruff]: https://github.com/charliermarsh/ruff
[OIDC]: https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi
[mkdocs]: https://www.mkdocs.org
[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/
[GitHub Pages]: https://pages.github.com
[copier]: https://copier.readthedocs.io/en/stable/