⚡ Quickstart#

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

If you plan to use whiteprints frequently you can have a look at the installation guide.

This Page