A Clean Architecture template for a Rest API in python
Motivations, explanations, requirements & more details in my article Practical Clean Architecture in Typescript, Rust & Python
I personally use pipx, pyenv & pipenv.
pipenv install -r requirements.txt
# OR
pip install -r requirements.txt
define the environment on which we're running by adding ENV=<env>
, which will use the .env.<env>
file
ENV=dev python main.py
Used in CI/CD; using setup.cfg to centralize all the config
autopep8 -i -r --global-config=setup.cfg ./src
pylint --rcfile=setup.cfg ./src
flake8 --config=setup.cfg ./src
mypy --config-file=setup.cfg ./src
Here's what done in order to mock the SPI
- db: through pytest's
conftest.py
's fixtures that execute before the tests, the database is created & the test data is added - http: here the "real" requests to the "real" API were recorder by
vcrpy
and they're referenced fromtest/fixtures/vcr_cassettes
for each test in order to get the same request to be replayed
ENV=test pytest
swagger: http://127.0.0.1:8000/docs