.. argus-toolbelt documentation master file, created by
   sphinx-quickstart on Mon Jul 27 16:08:16 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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.

Usage
-----

As with most other packages, Argus Toolbelt is available on PyPi.

.. code:: bash

   pip install argus-toolbelt

After the package has been installed, it can be ran as ``argus-cli`` on
the commandline.

For a full list of commands, try:

.. code:: bash

   argus-cli --help

If you for example want to check statistics for all cases, you can
write:

.. code:: bash

   argus-cli cases statistics

Development
-----------

This repository is using `Poetry <https://python-poetry.org/>`__ as it’s
dependency system, meaning it has to be installed on your system first.

.. code:: bash

   pip install poetry

To install this repository use:

.. code:: bash

   poetry install

Now you should be able to run with:

.. code:: bash

   poetry run argus-cli

.. toctree::
   :caption: Contents:
   :maxdepth: 5
   :hidden:

   getting_started
   configuration/index
   usage_examples
   concepts
   caveats
   guides/index
   commands/index
   troubleshooting
   changelog
   development/index