Skip to content

Developer.md

Latest commit

 

History

History
36 lines (24 loc) · 1.1 KB

Developer.md

File metadata and controls

36 lines (24 loc) · 1.1 KB
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

The version number needs to be bumped in pyproject.toml and template.yaml (in Metadata.SemanticVersion). Note that both should match.

Then, to publish a new version, create a release and specify a tag that matches the SemanticVersion that appears in template.yml (and pyproject.toml) 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.