About

This package provides command line access to Encapsia over the REST API.

All of these are designed to work with server 1.5 and beyond.

Autocomplete

Setup autocomplete using the instructions found on https://github.com/click-contrib/click-completion

Tests

Unit tests

Run:

poetry run pytest

Walkthrough Tests

Prerequisite: an instance of ice must be running on your localhost, and valid token for it must be present in your key store.

See the walkthrough_tests directory for bash scripts which exercise the CLI.

Run them e.g. with:

poetry run bash walkthrough_tests/all.sh

or test specific subcommands with:

poetry run bash walkthrough_tests/token.sh

Note that these tests are not self-verifying; they just provide helpful coverage, assurance, and working documentation.

Release checklist

• Run: poetry run black .
• Run: poetry run isort .
• Run: poetry run flake8 .
• Run: poetry run mypy .
• Ensure "tests" run ok (see above).
• Capture test output and commit with: poetry run bash walkthrough_tests/all.sh 2>&1 | poetry run ansi2html -f 80% >WALKTHROUGH.html
• Ensure git tag and package version are equal.