Todo Clean Architecture Sample package

This is a simple todo application packaged for pypi.

Requirements

pip install todo-clean-architecture-sample

Note: package is not yet published

Usage

TBD

Development

Requirements

• python >= 3.7
• poetry

git clone https://github.com/Oltho/todo-clean-architecture-sample.git
cd todo-clean-architecture-sample
poetry install

Pre-commit check

pre-commit is a framework for managing pre-commit hooks. These hooks help to identify simple issues before committing code for review.

To use this tool, first install it and then the git hooks:

$ pip install pre-commit
$ pre-commit install

Testing

Tox:

All testing can be done thought tox, you can provide the tox environement to run with tox -e <environement_to_run>

List of environments availables:

• flake8: run flake8 linter
• isort: run isort linter
• black: run black code formating
• mypy: run mypy type checker
• linters: run flake8, isort, black tox environments
• bandit: run bandit AST
• safety: run safety dependencies check
• security: run bandit, safety tox environments

You can also just run the tox command that will run default(pytest), linters, mypy, security environments.

Note: you might need to prepend poetry run in front of your command eg: poetry run tox

Todo

• Integration of SonarQube
• Update code with clean architecture and 12 app factor
• Handle semver
• Automated github release
• CI:
  • jenkins

Acknowledgements

Inspired by:

• python-package-template
• pyscaffold
• flask
• django
• install-poetry