Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whiteprints/whiteprints
A Copier-based cookiecutter for creating Python projects managed by uv.
https://github.com/whiteprints/whiteprints
babel cookiecutter copier github-actions pytest readthedocs sigstore sphinx template uv
Last synced: about 1 hour ago
JSON representation
A Copier-based cookiecutter for creating Python projects managed by uv.
- Host: GitHub
- URL: https://github.com/whiteprints/whiteprints
- Owner: whiteprints
- License: gpl-3.0
- Created: 2024-10-04T12:30:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:48:42.000Z (3 months ago)
- Last Synced: 2024-10-29T10:04:44.101Z (3 months ago)
- Topics: babel, cookiecutter, copier, github-actions, pytest, readthedocs, sigstore, sphinx, template, uv
- Language: Python
- Homepage: https://whiteprints.readthedocs.io/en/stable
- Size: 305 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Whiteprints
A Copier-based cookiecutter for creating Python projects managed by uv.
## Table of contents
- [Background](#background)
- [Highlights](#highlights)
- [Install](#install)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [Licensing](#licensing)
## Background
whiteprints is a command line to generate [Python] projects managed by [uv].
This is currently for my personal use, the documentation needs to be vastly
improved. However if you like the project feel free to use it, ask me questions
and even contribute 😊.
## Highlights
- Managed by [uv]
- [Just], [Pytest] and [Sphinx] for the development
- Template for [GitHub] with actions to publish to [PyPI], [ReadTheDocs] and
[CodeCov]
The whiteprint command line is under [GPL-3.0-or-later] license, however the
code templates used to generate the code are under [MIT-0] license.
### Try it!
All you need is a working `uv`. If you don't already have it just open a
terminal and run:
- On macOS and Linux:
```console
curl -LsSf https://astral.sh/uv/install.sh | sh
```
- On Windows:
```console
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
```
Then just run whiteprints with uvx:
```
uvx whiteprints init my_awesome_project
```
Answer a few questions and you're ready to go 🚀.
This will create a directory named `my_awesome_project` containing your [Python] project.
To generate a [GitHub] template please look at the command line help
```
uvx whiteprints init --help
```
You may also have a look at the [Documentation](https://whiteprints.readthedocs.io/en/stable/)
## Documentation
See: https://whiteprints.readthedocs.io/en/stable/.
## Install
See [INSTALL.md](INSTALL.md).
## Maintainers
See [MAINTAINERS.md](MAINTAINERS.md).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Contributors
## Licensing
The _[Python]_ **code** of this project is distributed under license [GPL-3.0-or-later].
In case of doubt, please check the [SPDX] header of each individual source code file.
[Python]: https://www.python.org/
[SPDX]: https://spdx.dev/
[REUSE]: https://reuse.software/
[uv]: https://docs.astral.sh/uv/
[Just]: https://just.systems/man/en/
[Pytest]: https://docs.pytest.org/en/stable/
[Sphinx]: https://www.sphinx-doc.org/en/master/index.html
[PyPI]: https://pypi.org/
[ReadTheDocs]: https://about.readthedocs.com/
[CodeCov]: https://about.codecov.io/
[GPL-3.0-or-later]: https://spdx.org/licenses/GPL-3.0-or-later
[MIT-0]: https://spdx.org/licenses/MIT-0
[GitHub]:https://github.com/
