FastDoc

Setup

Install uv: https://docs.astral.sh/uv/getting-started/installation/

git init
uv sync --dev
git add .
git commit -m "Initial commit"
uv run pre-commit install # optional

Run

To execute your software you have two options:

Option 1: Direct execution

uv run fastapi run main.py

Option 2: Run as installed package

uvx --from . fastdoc

Development

Just run uv run fastapi dev main.py and you are good to go!

Update from template

To update your project with the latest changes from the template, run:

uvx --with copier-template-extensions copier update --trust

You can keep your previous answers by using:

uvx --with copier-template-extensions copier update --trust --defaults

(Optional) pre-commit

pre-commit is a set of tools that help you ensure code quality. It runs every time you make a commit.

First, install pre-commit:

uv tool install pre-commit

Then install pre-commit hooks:

pre-commit install

To run pre-commit on all files:

pre-commit run --all-files

How to install a package

Run uv add <package-name> to install a package. For example:

uv add requests

Visual studio code

If you are using visual studio code install the recommended extensions

Development with docker

A basic docker image is already provided, run:

docker compose up --build watch

Tools installed

• uv
• pre-commit (optional)