Getting Started
===============

Initial configuration
---------------------
Welcome to Aiviro! Follow these steps to set up your Aiviro environment:

1. **Obtain Your License Key**:
   We will send you your license key. If you have not received it, please contact us at `support@aiviro.com <mailto:support@aiviro.com>`_.

2. **Install the Aiviro Package**:
   Install the Aiviro package using pip. Refer to the :ref:`Installation` section for detailed instructions.

3. **Set Up Your Client ID and API Key**:
   Use the `aiviro-cli` tool to configure your client ID and API key.

   .. code-block:: sh

      # Set up client ID and API key
      (venv) aiviro-cli config login --client-id <your-client-id> --api-key <your-api-key>

4. **Verify Your Configuration**:
   You can check your overall configuration using the `aiviro-cli` tool. For more detailed configuration options, refer to the :ref:`Global Configuration` section.

   .. code-block:: sh

      (venv) aiviro-cli config print

You’re ready to go!


Installing Aiviro
-----------------

Requirements
~~~~~~~~~~~~
.. _Python: https://www.python.org/downloads/

Aiviro requires Python_ **64-bit** version, we recommend to you to use Python 3.11 version.
Currently supported Python versions are **3.10, 3.11, 3.12**.

.. list-table:: Supported Operating Systems and CPU Architectures
   :widths: 30 20 20 20
   :header-rows: 1

   * - CPU
     - Linux
     - Windows
     - MacOSX
   * - x86_64
     - ✅
     - ✅
     - ✅
   * - arm64
     - ❌
     - ❌
     - ✅


Installation
~~~~~~~~~~~~
To install the Aiviro package via pip, follow these steps:

.. 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 and additional features, you may need to install extra dependencies.

.. _chrome-driver: https://chromedriver.chromium.org/downloads
.. _prefect: https://docs-v1.prefect.io/api/latest/

* **Web Robot** - for using Web Robot you have to install chrome-driver_.
* **Desktop Robot** - for using Desktop Robot you have to install **pyautogui** python packages.
* **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 includes optional modules, which can be installed using the "extras" syntax:

.. code-block:: bash

    pip install -i https://pypi.aiviro.com "aiviro[extra_1,extra_2]"

Example of extra packages include:

* ``all``: Includes all optional dependencies
* ``web``: Tools for using Web Robot (see :class:`~.WebRobot`)
* ``desktop``: Tools for using Desktop Robot (see :class:`~.DesktopRobot`)
* ``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 CLI reader scripts, Invoice Reader & read Excel files (see :ref:`aiviro reader cli`, :ref:`Reader`, :ref:`Excel`)
* ``deploy``: Tools for deploying Aiviro modules as web applications (see :ref:`Deployment as Web App`)


Update
~~~~~~
To update Aiviro and any additional dependencies, use the following command with the `-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]

For updating chrome-driver_, download the latest version and reinstall it.

For updating Aiviro in server deployment, refer to the :ref:`Update Agent` section.