Getting Started

Initial configuration

  1. We will send you your licence key. If you did not get it, please contact us at

  2. Download a configuration file and set-up your api_key and client_id variables in it.

Here is a configuration file aiviro_config.yaml

  1. Set-up a path to your aiviro_config file using system variable AIVIRO_CONFIG

# linux
export AIVIRO_CONFIG=path/aiviro_config.yaml
# windows
SET AIVIRO_CONFIG=path/aiviro_config.yaml

Installing Aiviro


Aiviro requires Python 64-bit version, we recommend to you to use Python 3.8 or 3.9 version. Currently supported Python versions are 3.8, 3.9, 3.10.

Supported OS with respective CPU architecture








To install aiviro package via pip, run:

# install aiviro
pip install -i aiviro

Optional dependencies

To work with different robots, you have to install some additional dependencies.

  • Web Robot - for using Web Robot you have to install chrome-driver.

  • RDP Robot - for using RDP Robot (Remote Desktop Protocol) you have to install our PyFreeRDP python package.

# install aiviro & pyfreerdp at once
pip install -i aiviro[rdp]

Aiviro also ships with a number of optional modules, which can be installed using “extras” syntax:

pip install -i "aiviro[extra_1,extra_2]"

Example of extra packages include:

  • all_extras: includes all of the optional dependencies

  • rdp: tools for using RDP Robot - see RDPRobot

  • pdf: tools for working with PDF files - see PDFRobot

  • dxf: tools for working with DXF files

  • email: tools for working with IMAP, SMTP protocols - see Email

  • prefect: tools for working with Prefect flows - see Flow Example

  • codes: tools to extract QR & Bar codes - see QR, Bar Codes

  • reader: tools for using aiviro-cli reader scripts & Universal Parser - see Reader Scripts, Reader


To update aiviro & additional dependencies, we use similar command as for installation, we just need to add -U option.

# update aiviro
pip install -i -U aiviro

# update aiviro & pyfreerdp at once
pip install -i -U aiviro[rdp]

To update chrome-driver, you have to download a new version of it and reinstall it.