CONTRIBUTING.md

asdf

We use asdf to manage plugins.

asdf plugin-add nodejs
asdf plugin-add python
sudo apt update & sudo apt upgrade
sudo apt install libffi-dev libncurses5-dev zlib1g zlib1g-dev libssl-dev libreadline-dev libbz2-dev libsqlite3-dev

Python

We use pip to manage dependencies. These are needed in order to run tests

pip install -r requirements.test.txt

Tests

Unit Tests

Unit tests are written utilising pytest. To run them

python -m pytest tests/unit

Integration Tests

Integration tests are written utilising pytest. To run them

API_KEY=<<OCTOPUS_API_KEY>> python -m pytest tests/integration