COOKIECUTTER_UPDATES.md

Source

This project was generated from the (3Amigos CookieCutter Template)[https://github.com/3amigos-dev/cookiecutter-3amigos-py] this file records the updates received from the upstream cookiecutter template so that it is clear what upstream updates have already been applied to consider application of new updates.

Updates from the Cookiecutter Template

• Use an (Azure Pipelines)[https://azure.microsoft.com/en-au/services/devops/pipelines/] CI.
• Follow (3Amigos)[https://3amigos-dev.github.io/] to use CI container pattern.
• Use (spelling)[https://github.com/resplendent-dev/spelling] to check spelling in CI.
• Use (flake8)[https://github.com/PyCQA/flake8] for static code analysis.
• Use (bandit)[https://github.com/PyCQA/bandit] for security static analysis.
• Use (pylint)[https://github.com/PyCQA/pylint] for static code analysis.
• Use (isort)[https://github.com/timothycrosley/isort] for sorting imports.
• Use (towncrier)[https://github.com/hawkowl/towncrier] for news updates.
• Use (dlint)[https://github.com/duo-labs/dlint] for security static analysis.
• Use (safety)[https://github.com/pyupio/safety] to check package safety.
• Use (pytest)[https://github.com/pytest-dev/pytest/] for unit testing.
• Use (pytest-cov)[https://github.com/pytest-dev/pytest-cov] to check 100% unit test coverage.
• Use (pytest-xdist)[https://github.com/pytest-dev/pytest-xdist] for test parallelization.
• Use (pytest-azurepipelines)[https://github.com/tonybaloney/pytest-azurepipelines] to publish tests results and coverage to Azure Pipelines Artifacts.
• Use (resplendent)[https://github.com/resplendent-dev/resplendent] to spell check reStructuredText in spelling.
• Use (shellcheck)[https://github.com/koalaman/shellcheck] for shell script static analysis.
• Use (sphinx)[https://github.com/sphinx-doc/sphinx] for documentation generation.
• Use (twine)[https://github.com/pypa/twine] for publishing to PyPI.
• Use (black)[https://github.com/psf/black] for code format.
• Badge for (PyPI)[https://pypi.org/]
• Badge for (ReadTheDocs)[https://readthedocs.org/]
• Badge for (Azure Pipelines)[https://azure.microsoft.com/en-au/services/devops/pipelines/]
• Badge for (Coveralls)[https://coveralls.io/]
• Badge for (black)[https://github.com/psf/black]

Minor Updates

• Installation details on README.md