Code Monkey home page Code Monkey logo

clean-architecture-python's Introduction

Clean Architecture With Python

This repository provides a template for building applications using the Clean Architecture principles with Python.

Tests

Coverage

Technology Stack

  • Python
  • FastAPI
  • SQLAlchemy
  • Docker
  • pytest
  • coverage

Download the Project

git clone https://github.com/javiertelioz/clean-architecture-python.git

Setup

Navigate to the project directory:

cd clean-architecture-python

Run the Application

Start the application using Docker Compose:

docker-compose up -d

Once the application is running, you can access the API documentation at http://localhost:8000.

Linting

Lint the code using the following command:

docker-compose run --rm web autopep8 --in-place --aggressive --recursive .

Running Tests

Run the tests using the following command:

docker-compose run --rm web pytest

Test Coverage

To generate a test coverage report, run the following commands:

docker-compose run --rm web coverage run -m pytest
docker-compose run --rm web coverage report -m

The coverage report will show the percentage of code coverage for the project.

Feel free to customize the code and directory structure to suit your specific needs. Happy coding!

clean-architecture-python's People

Watchers

 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.