Skip to content

History

v1.0

first release with the following features:

  • Poetry: Manage version, dependancy, build and release
  • Mkdocs: Writting your docs in markdown style
  • Testing with Pytest (unittest is still supported out of the box)
  • Code coverage report and endorsed by Codecov
  • Tox: Test your code against environment matrix, lint and artifact check.
  • Format with Black and Isort
  • Lint code with Flake8 and Flake8-docstrings
  • Pre-commit hooks: Formatting/linting anytime when commit/run local tox/CI
  • Mkdocstrings: Auto API doc generation
  • Command line interface using Python Fire (optional)
  • Continuouse Integration/Deployment by github actions, includes:
  • publish dev build/official release to AWS CodeArtifact automatically when CI success
  • publish documents automatically when CI success
  • extract change log from github and integrate with release notes automatically
  • Host your documentation from Git Pages with zero-config