Getting Started =============== Initial configuration --------------------- 1. We will send you your licence key. If you did not get it, please contact us at support@aiviro.com 2. Install Aiviro package using pip, see :ref:`Installation` section. 3. Set-up your ``client-id`` and ``api-key`` using ``aiviro-cli`` tool. .. code-block:: bash # set-up client-id & api-key (venv) aiviro-cli config login --client-id --api-key 4. You're ready to go! You can check your overall configuration using ``aiviro-cli`` tool. For more detailed configuration options, see :ref:`Global Configuration` section. .. code-block:: bash (venv) aiviro-cli config print Installing Aiviro ----------------- Requirements ~~~~~~~~~~~~ .. _Python: https://www.python.org/downloads/ 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**. .. list-table:: Supported OS with respective CPU architecture :widths: 30 20 20 20 :header-rows: 1 * - CPU - Linux - Windows - MacOSX * - x86_64 - ✅ - ✅ - ✅ * - arm64 - ❌ - ❌ - ✅ Installation ~~~~~~~~~~~~ To install ``aiviro`` package via pip, run: .. code-block:: bash # 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. .. _chrome-driver: https://chromedriver.chromium.org/downloads .. _prefect: https://docs.prefect.io/ * **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. .. code-block:: bash # 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: .. code-block:: bash pip install -i https://pypi.aiviro.com "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 :class:`~.RDPRobot` * ``pdf``: tools for working with PDF files - see :class:`~.PDFRobot` * ``dxf``: tools for working with DXF files * ``email``: tools for working with IMAP, SMTP protocols or Outlook - see :ref:`Email` * ``prefect``: tools for working with Prefect_ flows - see :ref:`Flow Example` * ``codes``: tools to extract QR & Bar codes - see :ref:`QR, Bar Codes` * ``reader``: tools for using `aiviro-cli reader` scripts & `Universal Parser` - see :ref:`aiviro reader cli`, :ref:`Reader` * ``excel``: tools to read Excel files - see :ref:`Excel` * ``deploy``: tools for deploying Aiviro modules as web applications - see :ref:`Deployment as Web App` Update ~~~~~~ To update ``aiviro`` & additional dependencies, we use similar command as for installation, we just need to add ``-U`` option. .. code-block:: bash # 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.