Getting Started
Initial configuration
We will send you your licence key. If you did not get it, please contact us at support@aiviro.com
Install Aiviro package using pip, see Installation section.
Set-up your
client-id
andapi-key
usingaiviro-cli
tool.
# set-up client-id & api-key
(venv) aiviro-cli config login --client-id <your-client-id> --api-key <your-api-key>
You’re ready to go! You can check your overall configuration using
aiviro-cli
tool. For more detailed configuration options, see Global Configuration section.
(venv) aiviro-cli config print
Installing Aiviro
Requirements
Aiviro requires Python 64-bit version, we recommend to you to use Python 3.10 or 3.11 version. Currently supported Python versions are 3.9, 3.10, 3.11.
CPU |
Linux |
Windows |
MacOSX |
---|---|---|---|
x86_64 |
✅ |
✅ |
✅ |
arm64 |
❌ |
❌ |
✅ |
Installation
To install aiviro
package via pip, run:
# create virtual environment
python -m venv venv
# activate virtual environment
# linux
source venv/bin/activate
# windows
venv\Scripts\activate.bat
# install aiviro
(venv) 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, Readerexcel
: tools to read Excel files - see Exceldeploy
: tools for deploying Aiviro modules as web applications - see Deployment as Web App
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.