Python api example project

Steps to run the api locally

1. Pre-requisites

• Ensure the poetry is installed
• Check venv path of poetry by running poetry env info

Virtualenv
Python:         3.8.10
Implementation: CPython
Path:           /home/koelkast/.cache/pypoetry/virtualenvs/python-api-example-R7RR5aY2-py3.8
Valid:          True

System
Platform: linux
OS:       posix
Python:   /usr

• Add the virtualenv path to your IDE's Python intepreter path

2. Install dependencies

  poetry install

3. Launch the app (from root folder of project)

  uvicorn src.main:app --reload

  Call the API running locally on: http://127.0.0.1:8000

Code formatting

Save brainpower and let the Black does the work.

Before commiting the code, run the following command:

  black ./src

The source code will be re-formatted by Black's sensible default config