Development - Contributing
First, you might want to see the basic ways to help FastAPI and get help.
If you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.
If you are using Pipenv, you can create a virtual environment and install the packages with:
pipenv install --dev
Then you can activate that virtual environment with:
If you are not using Pipenv, you can create a virtual environment with your preferred tool, and install the packages listed in the file
FastAPI uses Flit to build, package and publish the project.
If you installed the development dependencies with one of the methods above, you already have the
To install your local version of FastAPI as a package in your local environment, run:
flit install --symlink
It will install your local FastAPI in your local environment.
Using your local FastAPI
If you create a Python file that imports and uses FastAPI, and run it with the Python from your local environment, it will use your local FastAPI source code.
And if you update that local FastAPI source code, as it is installed with
--symlink, when you run that Python file again, it will use the fresh version of FastAPI you just edited.
That way, you don't have to "install" your local version to be able to test every change.
There is a script that you can run that will format and clean all your code:
It will also auto-sort all your imports.
For it to sort them correctly, you need to have FastAPI installed locally in your environment, with the command in the section above:
flit install --symlink
The documentation uses MkDocs.
All the documentation is in Markdown format in the directory
Many of the tutorials have blocks of code.
In most of the cases, these blocks of code are actual complete applications that can be run as is.
In fact, those blocks of code are not written inside the Markdown, they are Python files in the
And those Python files are included/injected in the documentation when generating the site.
Docs for tests
Most of the tests actually run against the example source files in the documentation.
This helps making sure that:
- The documentation is up to date.
- The documentation examples can be run as is.
- Most of the features are covered by the documentation, ensured by the coverage tests.
During local development, there is a script that builds the site and checks for any changes, live-reloading:
It will serve the documentation on
That way, you can edit the documentation/source files and see the changes live.
Apps and docs at the same time
And if you run the examples with, e.g.:
uvicorn tutorial001:app --reload
as Uvicorn by default will use the port
8000, the documentation on port
8008 won't clash.
There is a script that you can run locally to test all the code and generate coverage reports in HTML:
This command generates a directory
./htmlcov/, if you open the file
./htmlcov/index.html in your browser, you can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing.