whiteprints

Whiteprints

A Copier-based cookiecutter for creating Python projects managed by uv.

Table of contents

• Background
• Highlights
• Install
• Maintainers
• Contributing
• 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:

  curl -LsSf https://astral.sh/uv/install.sh | sh
  

• On Windows:

  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

Documentation

See: https://whiteprints.readthedocs.io/en/stable/.

Install

See INSTALL.md.

Maintainers

See MAINTAINERS.md.

Contributing

See CONTRIBUTING.md.

Contributors

Romain Brault 🚇 ⚠️ 💻

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.