A framework for creating interactive commands with Argus' APIs

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mnemonic from gravatar.com mnemonic

Unverified details

These details have not been verified by PyPI
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: OSI Approved (ISC)

Author: mnemonic

Requires: Python >=3.6.2, <4.0.0

Classifiers

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

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for mnemonic from gravatar.com mnemonic

Unverified details

These details have not been verified by PyPI
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: OSI Approved (ISC)

Author: mnemonic

Requires: Python >=3.6.2, <4.0.0

Classifiers

Release history Release notifications | RSS feed

6.19.0

6.18.2

6.18.1

6.18.0

6.17.4

6.17.3

6.17.2

6.17.1

6.17.0

6.16.0

6.15.0

6.14.7

6.14.6

6.14.5

6.14.4

This version

6.14.3

6.14.2

6.14.1

6.14.0

6.13.1

6.13.0

6.12.9

6.12.8

6.12.7

6.12.6

6.12.5

6.12.4

6.12.3

6.12.2

6.12.1

6.12.0

6.11.0

6.10.0

6.9.3

6.9.2

6.9.1

6.9.0

6.8.2

6.8.1

6.8.0

6.7.1

6.7.0

6.6.1

6.6.0

6.5.0

6.4.0

6.3.0

6.2.0

6.1.6

6.1.5

6.1.4

6.1.3

6.1.2

6.1.1

6.1.0

6.0.2

6.0.1

6.0.0

5.1.1

5.1.0

5.0.9

5.0.8

5.0.7

5.0.6

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

5.0.0

4.8.2

4.8.1

4.8.0

4.7.0

4.6.1

4.6.0

4.5.2

4.5.1

4.5.0

4.4.1

4.4.0

4.3.1

4.3.0

4.2.0

4.1.5

4.1.4

4.1.3

4.1.2

4.1.1

4.1.0

4.0.0

3.8.2

3.8.1

3.8.0

3.7.2

3.7.0

3.6.1

3.6.0

3.5.0

3.4.3

3.4.2

3.3.2

3.3.1

3.3.0

3.2.0

3.1.1

3.1.0

3.0.2

3.0.1

3.0.0

2.2.0

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.14.2

1.14.0

1.13.13

1.13.12

1.13.11

1.13.10

1.12.0

1.11.10

1.11.9

1.11.8

1.11.7

1.11.6

1.11.5

1.11.4

1.11.3

1.10.3

1.10.2

1.10.1

1.10.0

1.9.1

1.9.0

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.3

1.7.2

1.7.1

1.6.13

1.6.12

1.6.11

1.6.10

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.2

1.6.1

1.6.0

1.5.5

1.5.4

1.5.3

1.5.1

1.5.0

1.4.16

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.19

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.31

1.1.30

1.1.29

1.1.28

1.1.27

1.1.26

1.1.24

1.1.23

1.1.22

1.1.21

1.1.19

1.1.18

1.1.9

1.1.8

1.1.6

1.1.5

1.1.3

1.1.1

1.1.0

1.0.31

1.0.27

1.0.26

1.0.23

1.0.22

1.0.17

1.0.15

1.0.13

1.0.11

1.0.10

1.0.9

1.0.8

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0

Download files

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

Source Distribution

argus_toolbelt-6.14.3.tar.gz (72.0 kB view hashes)

Uploaded Source

Built Distribution

argus_toolbelt-6.14.3-py3-none-any.whl (95.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page