Skip to main content

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

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

Run them e.g. with:

bash walkthrough_tests/all.sh --host <host> --example-plugin-src ../inf-ice-example-plugin/

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

Release checklist

  • Run: black .
  • Run: isort
  • Run: flake8 .
  • Ensure "tests" run ok (see above). Also capture output and commit with: bash walkthrough_tests/all.sh --host <host> --example-plugin-src ../inf-ice-example-plugin/ 2>&1 | ansi2html -f 80% >WALKTHROUGH.html
  • Ensure git tag, package version, and enacpsia_cli.__version__ are all equal.

TODO

  • Feature: Add plugins command for linting e.g. consistency of capabilities
  • Feature: Add package command for running standard tasks
  • Feature: Add "encapsia plugins reactor" to forward local calls to remote for even easier dev without installing anything except the SQL.
  • Feature: Use click-web to create an encapsia webserve command?? Put in a plugin?

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for encapsia-cli, version 0.1.16
Filename, size File type Python version Upload date Hashes
Filename, size encapsia_cli-0.1.16-py3-none-any.whl (18.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size encapsia-cli-0.1.16.tar.gz (14.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page