Getting Started
Initial configuration
We will send you your licence key. If you did not get it, please contact us at support@aiviro.com
Download a configuration file and set-up your
api_key
andclient_id
variables in it.
Here is a configuration file aiviro_config.yaml
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
Requirements
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.
CPU |
Linux |
Windows |
MacOSX |
---|---|---|---|
x86_64 |
✅ |
✅ |
✅ |
arm64 |
❌ |
❌ |
✅ |
Installation
To install aiviro package via pip, run:
# install aiviro
pip install -i https://pypi.aiviro.com 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 https://pypi.aiviro.com aiviro[rdp]
Aiviro also ships with a number of optional modules, which can be installed using “extras” syntax:
pip install -i https://pypi.aiviro.com "aiviro[extra_1,extra_2]"
Example of extra packages include:
all_extras
: includes all of the optional dependenciesrdp
: tools for using RDP Robot - seeRDPRobot
pdf
: tools for working with PDF files - seePDFRobot
dxf
: tools for working with DXF filesemail
: tools for working with IMAP, SMTP protocols - see Emailprefect
: tools for working with Prefect flows - see Flow Examplecodes
: tools to extract QR & Bar codes - see QR, Bar Codesreader
: tools for using aiviro-cli reader scripts & Universal Parser - see Reader Scripts, Reader
Update
To update aiviro & additional dependencies, we use similar command as for installation, we just need to add -U
option.
# update aiviro
pip install -i https://pypi.aiviro.com -U aiviro
# update aiviro & pyfreerdp at once
pip install -i https://pypi.aiviro.com -U aiviro[rdp]
To update chrome-driver, you have to download a new version of it and reinstall it.