==========
Aiviro CLI
==========

Aiviro comes with few CLI commands for creating, managing and inspecting your Aiviro scripts.
For detailed information about available commands and theirs arguments, see:

.. code-block:: shell

    $ aiviro-cli --help


Logs Management
===============

Process Metadata Logs
~~~~~~~~~~~~~~~~~~~~~

As mentioned in the section :ref:`Generate Images`, you can generate images from Aiviro metadata.

This is done by ``aiviro-cli log generate`` command, see the example of it's usage:

.. code-block:: shell

    $ aiviro-cli log generate --help
    $ aiviro-cli log generate --input logs/run-demo_test/log_img/metadata/ \\
        --output logs/run-demo_test/log_img/ \\
        --number 20
    $ aiviro-cli log generate --input logs/run-demo_test/log_img/metadata/ \\
        --output logs/run-demo_test/log_img/ \\
        --since 1955.11.12-6:38
    $ aiviro-cli log generate --input logs/run-demo_test/log_img/metadata/ \\
        --output logs/run-demo_test/log_img/ \\
        --before 2015.10.21-7:28
    $ aiviro-cli log generate --input logs/run-demo_test/log_img/metadata/ \\
        --output logs/run-demo_test/log_img/ \\
        --since 1955.11.12-6:38 \\
        --before 2015.10.21-7:28 \\
        --number 100


Analyze Errors
~~~~~~~~~~~~~~

Sometimes your scripts may encounter some errors, to find the exact error-message and corresponding images, in long running scripts may be time demanding.
Therefore we created a helpful script, which automatically detects errors in the text logs and selects appropriate metadata based on the time the error occurred, which are then copied into separate sub-folders.

This is done by ``aiviro-cli log analyze`` command, see the example of it's usage:

.. code-block:: shell

    $ aiviro-cli log analyze --help
    $ aiviro-cli log analyze --run logs/run-2021-02-10_10-25-456-main/ \\
        --number 30
    $ aiviro-cli log analyze --logs logs/ --window 0:5:0 --number 50


Projects & Scenarios
====================

Create Aiviro Project & Scenarios
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To create a new Aiviro project, we predefined a repository structure how such a project should look like.
This can be initialize by ``aiviro-cli create project``. To add new scenario into already existing project, use ``aiviro-cli create scenario`` command:

.. warning::
    This is experimental feature! Be wary that behaviour may change in future releases.

.. code-block:: shell

    $ aiviro-cli create project --help
    $ aiviro-cli create project --context path/to/project/folder

.. code-block:: shell

    $ aiviro-cli create scenario --help
    $ aiviro-cli create scenario --prefect-project Aiviro --prefect-flow "Invoice Processing" --prefect-env rdp


Aiviro Reader
=============

.. note::
    It's required to install ``reader`` and ``pdf`` from :ref:`Optional dependencies` section.


They are several scripts under  ``aiviro-cli reader --help`` command, using which you can extract data from provided PDF files.
Or calculate an accuracy of Aiviro Reader based on your ground-truth data export.

.. list-table:: Currently supported items in Aiviro Reader
   :widths: 40 50
   :header-rows: 1

   * - Name
     - Identification (Column name)
   * - Supplier Vat Number
     - supplier_vat_number
   * - Supplier ID
     - supplier_id
   * - Subscriber Vat number
     - subscriber_vat_number
   * - Subscriber ID
     - subscriber_id
   * - Tax Date
     - tax_date
   * - Invoice Date
     - invoice_date
   * - Invoice Number
     - invoice_number
   * - Order Number
     - order_number
   * - Variable Symbol
     - variable_symbol
   * - Currency
     - currency
   * - Vat Rate
     - vat_rate
   * - Total Amount
     - total_amount
   * - Total Amount Without Vat
     - total_amount_without_vat

To extract all supported items from pdf files, use a following command:

.. code-block:: shell

    $ aiviro-cli reader extract --help
    $ aiviro-cli reader extract --input folder/pdfs/ --output output/folder/

For calculating reader's accuracy, use a command below.
This calculation can be configured (*this is optional*) by providing a configuration file, see example of it below.
Download :download:`reader_config.yaml <../configs/reader_config.yaml>`

.. literalinclude:: ../configs/reader_config.yaml
   :language: yaml

* ``required_column`` - columns which must be contained in both input csv files
* ``map_column`` - used for renaming ground-truth csv file columns to standard name format

.. code-block:: shell

    $ aiviro-cli reader stats --help
    $ aiviro-cli reader stats --input export_data.csv --ground-truth gt_data.csv --output folder/ --config path/reader_config.yaml