omars44 / meerkat

An opinionated Clean Architecture example in python

meerkat

What do I get out of the box ?

• Clean Architecture in Python

• Falcon Framework RESTful API example

• Health endpoint example

• Marshmallow integration

• Docker example

• Github actions example runs the following

• Tests

• Black

• Flake8

• Mypy

• isort

But what does it mean ?

• Means it can be a starter project for your next project, whether falcon or CLI or * seriously any.

Now let's get started.

Installing the precommit/prepush hooks

API docs

http://0.0.0.0:8021/v1/docs

new service [how-to]

Write

• AggregateRoot
• data provider definitions [domain]
• data provider concrete implementation
• usecase
• Rest
  • definitions
  • schemas
• configurations/di
• configurations/rest/resouce

Running the app

make start

Local Development Setup

# Install dependencies
pipenv install --dev --deploy

# Setup pre-commit and pre-push hooks
pipenv run pre-commit install -t pre-commit
pipenv run pre-commit install -t pre-push

running tests:

make test

coverage found at: htmlcov/index.html

Credits

• Bookla Foundation's Team
• sourcery-ai/python-best-practices-cookiecutter project template.