Git Product home page Git Product logo

clean-architecture-python's Introduction

Clean architecture: python

A Clean Architecture template for a Rest API in python

How it works

Motivations, explanations, requirements & more details in my article Practical Clean Architecture in Typescript, Rust & Python

Installing

I personally use pipx, pyenv & pipenv.

pipenv install -r requirements.txt
# OR
pip install -r requirements.txt

Running

define the environment on which we're running by adding ENV=<env>, which will use the .env.<env> file

ENV=dev python main.py

Code quality & security

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

Testing

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 from test/fixtures/vcr_cassettes for each test in order to get the same request to be replayed
ENV=test pytest

API Documentation

swagger: http://127.0.0.1:8000/docs

clean-architecture-python's People

Contributors

msc29 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.