Client CLI for talking to an Encapsia system.
Project description
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 - Create
requirements.txtfor Snyk scanning with:poetry export -f requirements.txt >requirements.txt - Ensure git tag, package version, and
encapsia_cli.__version__are all equal.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file encapsia_cli-0.5.5.tar.gz.
File metadata
- Download URL: encapsia_cli-0.5.5.tar.gz
- Upload date:
- Size: 25.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/5.15.0-86-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 549082672b91da24d75bf092fb90be186e044f33e70b5b41d1780c301fcb792c |
|
| MD5 | 74701ac364cc1dcde9a8b47afdcc60a6 |
|
| BLAKE2b-256 | 2ec6ed7cb09b9603fe97ed5d94aa1983b116a502c17c113f7e23258e02daffef |
File details
Details for the file encapsia_cli-0.5.5-py3-none-any.whl.
File metadata
- Download URL: encapsia_cli-0.5.5-py3-none-any.whl
- Upload date:
- Size: 30.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/5.15.0-86-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6fee2b95561b9a7c59c59bfeeddb3bf94c3f71bfee3d2a3883c004d4774dc29f |
|
| MD5 | fdb80a42f96698ba4140fc2354c6c881 |
|
| BLAKE2b-256 | 08492ca3813b8aebf1bce0ca42e0d8541d06a7c89db69cf8ff398ab4ea8e22b2 |
