Python FastAPI Bigger Applications Template

This a template project, to demonstrate using FastAPI in a bigger application. The same file structure has been followed as per FastAPI docs.

This repository is intended as a quick-start and includes the following:

A Dockerfile to build the FastAPI application following guidelines
docker-compose.yml file to build and start the application
GitHub Action workflow to run linting and unit tests
Pre-commit hooks to run on each commit
Pydantic models as response models for endpoints
Unit and integration feature tests for endpoints

Usage

Install python packages used for the service
```
pip install -r requirements.txt
```
Run the FastAPI server, which will run on port 8000
```
python app/main.py
```
Endpoint documentation are available on http://127.0.0.1:8000/docs

Docker

Running the docker-compose.yml, will build a new image python-fastapi-bigger-applications-template-fastapi:latest which will be used for the fastapi service within the container.

docker-compose up -d

Tests

Unit tests are located in /tests/unit directory, run unit tests using:

pytest tests/unit

Additionally, a coverage report can be generated using pytest-cov:

pytest --cov=app tests/unit --cov-report=html:coverage_report

Will generate a coverage HTML file, in the /coverage_report/ directory, simply open the index.html in your chosen web browser.

Integration tests are located in /tests/integration directory, run integration using:

pytest tests/integration

Contributing

Git hook scripts are very helpful for identifying simple issues before pushing any changes. Hooks will run on every commit automatically pointing out issues in the code e.g. trailing whitespace.

To help with the maintenance of these hooks, pre-commit is used, along with pre-commit-hooks.

Please following these instructions to install pre-commit locally and ensure that you have run pre-commit install to install the hooks for this project.

Additionally, once installed, the hooks can be updated to the latest available version with pre-commit autoupdate.

GitHub Actions (CI/CD)

GitHub project has three workflow set up, found in .github/workflows/: