https://github.com/woltapp/wolt-python-package-cookiecutter
Cookiecutter for rapidly creating modern & high-quality Python packages
https://github.com/woltapp/wolt-python-package-cookiecutter
best-practices cookiecutter-template cruft python
Last synced: 4 months ago
JSON representation
Cookiecutter for rapidly creating modern & high-quality Python packages
- Host: GitHub
- URL: https://github.com/woltapp/wolt-python-package-cookiecutter
- Owner: woltapp
- License: mit
- Created: 2021-06-18T08:25:27.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T12:38:51.000Z (over 1 year ago)
- Last Synced: 2025-06-02T19:19:01.138Z (4 months ago)
- Topics: best-practices, cookiecutter-template, cruft, python
- Language: Python
- Homepage:
- Size: 1.95 MB
- Stars: 258
- Watchers: 9
- Forks: 44
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Wolt Python Package Cookiecutter
A [cookiecutter](https://cookiecutter.readthedocs.io/en/latest/README.html) (project template) for rapidly developing new open source Python packages. Best practices with all the modern bells and whistles included.
## Example projects which use Wolt Python Package Cookiecutter
* [jerry-git/pytest-split](https://github.com/jerry-git/pytest-split)
## Features
#### Automatic updates to the projects generated from this cookiecutter
* Powered by [cruft](https://cruft.github.io/cruft/)
* Keep your project up-to-date with best practices
#### Continuous integration
* Powered by [Github Actions](https://github.com/features/actions)
* Testing against multiple different versions
#### Documentation
* Automatically published as [GitHub Pages](https://pages.github.com/)
* Powered by [mkdocs-material](https://github.com/squidfunk/mkdocs-material)
* Auto-generated API documentation from docstrings via [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings)
* See the extensive list of [MkDocs plugins](https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins) which can help you
to tune the documentation to fit your project's needs
#### Automated releases
* Publishing to [PyPI](https://pypi.org/) when a release is made in GitHub
#### Changelog management
* Gently enforced: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
* GitHub releases get their description automatically populated based on the changelog content
* The _Unreleased_ section is automatically updated when a release is done
* Changelog is embedded in the documentation
#### Bells and whistles
* [Poetry](https://python-poetry.org/docs/) for managing dependencies and packaging
* [pre-commit](https://pre-commit.com/) for running all the goodies listed below
* [mypy](https://flake8.pycqa.org/en/latest/) for static type checking
* [ruff](https://beta.ruff.rs/docs/) for automatic formatting, linting and automatically fixing some linting errors
#### Automation
* Updates to the best practices (via GHA workflow which runs `cruft update` and creates a PR)
* Dependency updates (via GHA workflow which creates a PR)
## Usage
Make sure you have [`cruft`](https://github.com/cruft/cruft#installation) installed. Alternatively, you can use
[`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/installation.html) if you are not interested in
getting updates to the project "boilerplate" in the future.
Create a new project:
```sh
cruft create https://github.com/woltapp/wolt-python-package-cookiecutter
```
The CLI interface will ask some basic questions, such the name of the project, and then generate all the goodies
automatically.
After that you can make it a proper git repo:
```sh
cd
git init
git add .
git commit -m "Initial project structure from Wolt Python Package cookiecutter"
```
We update this cookiecutter template regularly to keep it up-to-date with the best practices of the Python world. You
can get the updates into your project with:
```sh
cruft update
```
### Configure secrets
#### `PYPI_TOKEN`
Required for publishing the package to [PyPI](https://pypi.org/). You can generate a token by logging into PyPI and
navigating to _Add API token_ in your [account settings](https://pypi.org/manage/account/).
#### `AUTO_UPDATE_GITHUB_TOKEN`
This cookiecutter template comes with an auto update feature if the project was created using cruft.
A GitHub action automatically checks for updates and creates a pull request.
Generate [personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)
and use it as the value for `AUTO_UPDATE_GITHUB_TOKEN` secret. When creating the access token, the following
permissions have to be granted
* repo
* workflow
### After the first release
The first release will create `gh-pages` branch which will contain the static files for the documentation. Enable GitHub
Pages in the _Pages_ section of the repository settings.