A framework for creating interactive commands with Argus' APIs
Project description
argus-toolbelt
Argus Toolbelt is a framework for unifying commandline tools to interact with Argus under one command. This framework also makes it easy for others to develop their own commands with a simple pythonic interface.
While any command can be made, Argus is also a first class citizen, meaning that a command developer won't have to deal with auth and HTTP requests.
Complete documentation for this project can be found at: argus toolbelt documentation
This repository is maintained by the tooling team
Usage
As with most other packages, Argus Toolbelt is available on PyPi.
pip install argus-toolbelt
After the package has been installed, it can be ran as argus-cli
on the
commandline. You'll find
For a full list of commands, try:
argus-cli --help
If you for example want to check statistics for all cases, you can write:
argus-cli cases statistics
Development
This repository is using Poetry as it's dependency system, meaning it has to be installed on your system first.
pip install poetry
To install this repository use:
poetry install
Now you should be able to run with:
poetry run argus-cli
prerequisites
- a python 3.6 or higher interpreter
- poetry
- Requisite access in Argus to the data you are trying to access.
processes
requesting changes
To request a change in this repository, create an ARGUSUSER ticket in JIRA
See existing tickets for this project
contributing
- All changes must be submitted as a PR towards the toolbelt-framework repository on stash
- All commits must be tagged with the correct JIRA ticket.
- All PRs be built successfully before merging.
- All changes must be reviewed and approved by one of the maintainers.
- Non-trivial changes SHOULD be reviewed by two individuals. This is not enforced, and is up to the author to decide.
- Any emergency changes MUST be documented properly in the associated JIRA ticket.
build and deployment
build process
- This project uses the standard tooling build in gitlab.
- In addition, documentation is built in the pipeline.
deployment process
- When a merge request is merged, a Python package is built and pushed to pypi.
- Documentation is automatically deployed to the internal and public documentation host.
Project details
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
Hashes for argus_toolbelt-6.14.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6328374dbb801ce6e542796ae941bb0a92250d6ea13c697697d32e14d2c63014 |
|
MD5 | 90a347ed44cc07908692ff7a0a80d038 |
|
BLAKE2b-256 | 5b8d28d5103ca346bb698a0aa363179f97115c3ff486f96c6f2457de2ecd6243 |