Workflows

Commands are the building blocks; workflows are the recipes. Each page here combines several pyfaro commands into an end-to-end task, and every example was run with a real uv and the real output is shown.

• A new library

  Create, sync, add a dependency, check, test and build a distributable package.

• A new CLI

  Scaffold a command-line app, run it in the project environment and install it as a tool.

• A FastAPI app

  From install to a running server and a passing CI workflow: create, add, dev, check, test, tasks and build.

• Adopt an existing project

  Preview and apply init, then bring quality tools into a project you already have.

• The quality gate

  Run check before every commit, let --fix tidy up, and wire it into a git hook.

• Continuous integration

  A GitHub Actions workflow that installs uv and Pyfaro, then syncs, checks and tests.

• Python versions

  List, install and pin interpreters and keep them consistent with requires-python.

• Troubleshooting

  Common errors from doctor, tools and friends, with their fixes and exit codes.

Before you start

These workflows assume Pyfaro and uv are installed (uv 0.9.26 or newer). Pyfaro never installs uv or Python for you; see Installation.