fp-github-template-example 0.0.1

package example

python package template

Content

• pytest for tests: make test
• ruff for linting/formatting: make lint (replaces both black and isort)
• .github with actions ready to be used
  • test runs lint checks and unit tests
  • publish-dev publishes feature branches (dev/dev-*) to testpypi
  • publish-main publishes semver tags to pypi

New project checklist

• Replace folder example with the actual package
• Replace LICENSE if MIT does not apply
• Search the project for # TODO to find the (minimum list of) places that need to be changed.
• Add PYPI credentials to secrets
  • PYPI_USERNAME and PYPI_TOKEN to publish tags to pypi
  • TESTPYPI_USERNAME and TESTPYPI_TOKEN to publish dev branches to testpypi