README.md

cars_api

A simple example of using Fast API in Python.

Preconditions:

• Python 3

Run local

Install dependencies

pip install -r requirements.txt

Run server

uvicorn app.main:app --reload

Run test

pytest app/test.py

Run with docker

Run server

docker-compose up -d --build

Run test

docker-compose exec app pytest test/test.py

API documentation (provided by Swagger UI)

http://127.0.0.1:8000/docs

Run server

docker-compose exec db psql --username=fastapi --dbname=fastapi_dev

Best Practices

• PEP8
• Black
• Zen of Python
• Solid Principles
• Commit Etiquettes
• Bash alias
• Structuring repo