Python Whiteprint, generate easily Python projects with (opinionated) best practices.
Documentation: https://python-whiteprint.readthedocs.io/en/latest/
Source Code: https://github.com/RomainBrault/python-whiteprint
Installation
Ensure that you have git and python3 installed.
Then install the required Python tools:
$ python3 -m pip install --user --upgrade pipx
$ pipx install poetry
$ pipx install nox
$ pipx inject nox nox-poetry rich
Eventually install Python Whiteprint:
$ pipx install python-whiteprint
Example
Create a local project
$ whiteprint init <my_project>
Create a GitHub project
$ whiteprint init <my_project> --github-token <my_github_token>
Note that the GitHub token must have repository, workflows and packages permissions.
Yet another Python Project scaffold/cookiecutter/generator?
Yes.
This project build upon the excellents cookiecutter-hypermodern-python by @cjolowicz as well as python-blueprint by @johnthagen.
You might want to check these projects as they might be more suited to your needs.
The documentation of this project is heavily inspired from @cjolowicz's work. We also recommend readings @cjolowicz's guide on modern Python tooling.
Differences compared to cookiecutter-hypermodern-python
- Use copier instead of the cookiecutter project,
- tweaks in the generated project (non exhaustively: CLI with Typer instead of Click, dynamic type checking with beartype, auto-API documentation),
- manage licenses with Reuse,
- more Github Actions and Community Standards and Community Standards,
- Ruff instead of Flake8 to auto-fix a maximum of code smells,
- strict linting with pylint,
- OCI Container images,
- localization with Babel.
1 maintainer
Release files for python-whiteprint 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| python_whiteprint-0.10.0.tar.gz | 26.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| python_whiteprint-0.10.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 62.2 kB
Release files / python_whiteprint-0.10.0.tar.gz
| Download URL | python_whiteprint-0.10.0.tar.gz |
|---|---|
| Size | 26.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8bf687678c620e61acb2aee1d67f8b058b8f1a6921fa94df858d72201b181a97
|
|
BLAKE2b-256 checksum How to use checksums |
571389ade7ccf9dbe3c0e57099aa4b7a0119dd49a38ff832b3564bc3eead3a91
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
Release files / python_whiteprint-0.10.0-py3-none-any.whl
| Download URL | python_whiteprint-0.10.0-py3-none-any.whl |
|---|---|
| Size | 35.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ff015319f071fa78c7df1a77e10a0b64cb3c0c947e73e3735abbe8ed913d2882
|
|
BLAKE2b-256 checksum How to use checksums |
db975816778678676dd615b13fbc334b0e71865c593585ba7d4e9d9fc32aa345
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.6
|
