Get started Python FastAPI

Client apps

• App-1
• App-2

Versions

3.9 <= python <= 3.10.4

---

NOTE: All database configuration names can be overridden by environment variables see settings.py file

---

Install with docker-compose

Then run:

docker-compose -f docker-compose.yml up

Mixed install with docker and host machine:

If you have already postgres installed in your host machine then:

Create database fastapidb

create database fastapidb; 

Run app with docker:

docker run -d --rm --network=host meschac38000/fast-api:latest

The ap running on http://127.0.0.1:8000/

Manual installation without docker

requirements:

- Postgresql
- python

Note that, you can create a virtual environment if you don't want to install requirements in your host machine

For that run the following command depending on your system:

python -m venv {venv-name}

activate this virtual environment

Linux or Mac

source {venv-name}/bin/activate

Windows

./{venv-name}/Scripts/activate

Install requirements

Upgrade pip

pip install --upgrade pip

install application requirements

pip install -r  requirements/common.txt

install dev requirements (useful to run tests)

pip install -r requirements/dev.txt

Database

Connect to your postgres BD using psql

psql -U postgres -p 5432 -h localhost

Then create DB fastapidb

CREATE DATABASE fastapidb;

Then edit correctly TORTOISE_ORM variable in the settings.py file.

We are using Aerich as database migrations tool. Init database by running the following aerich command:

aerich init-db

Run the app

python main.py

The app running on http://127.0.0.1:8000/

Fake Data

To load some fake data, go to http://127.0.0.1:8000/data which will load fake data.

Run all the tests

from root folder(Test-FastAPI/) run:

pytest

Contributors

Made by: