/cars

Example of architecture on an example of cars and food

Primary LanguagePythonMIT LicenseMIT

Cars

Cars CI/CD Python3.10 MIT License

Abstract

This project was conducted as part of an agility course at Paris Dauphine University. It is not necessarily a very great coherence because the goal was precisely to project into an Ireel world. However, the "real" inconsistency does not prevent developing a high quality project. We find thus:

  • ABC
  • Unit tests
  • Code coverage
  • Linter (pylint)
  • Design Patterns
  • Static typing (mypy)
  • Formater (black and isort)
  • Functional tests (with cucumber and behave)

This project consists of two packages:

  1. cars
  2. foods

The link between these two packages reside in the fact that a car can sell food (the Foodtruck concept)

Get started 🎉

  1. Clone the project

    git clone https://github.com/av1m/cars.git
    cd cars
  2. Run make command

    make install

Test the project

make test

Format the code

make format

Check all useful commands

make help