simplecalc

simplecalc is an example project to show how to set up an open source project from scratch.

Read the Blog Post

The blog talks about how this project was set up.

List of Covered Tools

Environment

• pyenv
  • pyenv-virtualenv
• poetry

Project Styling

• flake8
  • flake8-docstrings
  • darglint
• isort
  • seed-isort-config
• black
• pre-commit

Unit Testing

• pytest
  • pytest-cov
  • pytest-mock
  • xdoctest
• coverage
• tox

Continuous Integration

• Azure Pipelines

Documentation

• sphinx
• readthedocs
• sphinx_rtd_theme

Release

• towncrier
• poetry (again)

Documentation

Read the docs!