CONTRIBUTING.md

Contributing

Tests

When contributing pull requests, it's a good idea to run basic checks locally:

# install development dependencies
tpi (master)$ pip install pre-commit -r requirements-dev.txt
tpi (master)$ pre-commit install  # install pre-commit checks
tpi (master)$ pytest              # run all tests

Layout

• tpi/
  • __init__.py
  • bin.py - helper for downloading terraform binaries
  • terraform.py - main Python API
  • templates/ - HCL/JSON templates (main.tf)
  • main.py
    • get_main_parser() - returns tpi's own parser object
    • main() - tpi's own CLI application

Releases

Tests and deployment are handled automatically by continuous integration. Simply tag a commit v{major}.{minor}.{patch} and wait for a draft release to appear at https://github.com/iterative/tpi/releases. Tidy up the draft's description before publishing it.

Note that tagging a release is possible by commenting /tag vM.m.p HASH in an issue or PR.