Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 957 Bytes

Developer.md

File metadata and controls

33 lines (22 loc) · 957 Bytes
Raw

Setup Python Environment

  • Install pipenv using brew: brew install pipenv
  • Create virtualenv and install dependencies with pipenv install --dev --deploy

Running tests and linter locally

  • Run tests with pipenv run pytest
  • Ensure the code is PEP-8 compliant by using the flake8 linter: pipenv run flake8

Publishing a new version

To publish a new version create a release and specify a tag that matches the SemanticVersion that appears in the template.yml but prefixed with a v. For example, if the SemanticVersion is 1.2.3 then your release tag should be v1.2.3.

Code style

We use the black code formatter.

pip install black

We recommend using it with pre-commit:

pip install pre-commit
pre-commit install

Using these together will auto format your git commits.