Installation

Requirements

  • Python 3.10 or higher

Installation

Currently, there are three ways to install this package. In any case, make sure to first create and activate a Python virtual environment in which to install varvis_connector.

Option 1 is to install it via pip from PyPI:

pip install varvis-connector

Option 2 is to download either the “wheel” or source distribution package from the GitHub releases page and then install it via pip:

pip install varvis_connector-<VERSION>.whl   # or .tar.gz

Option 3 is downloading or cloning this repository. The package and its command-line utility can then be installed with pip install <path-to-repository>.

Configuration / environment variables

API URL and login credentials can be set as environment variables. It’s recommended to set these in a .env-file:

VARVIS_URL=https://...
VARVIS_USER=<USER>
VARVIS_PASSWORD=<PASSWORD>

The following environment variables are optional:

  • HTTPS_PROXY: Sets a proxy for all communication with the API.

  • VARVIS_SSL_VERIFY (0 or 1): Disables SSL certificate verification when set to 0 – only do this for development and testing (may be necessary in that case for some corporate network configurations where routers inspect SSL traffic).

  • VARVIS_CONNECTION_TIMEOUT: Set a connection timeout (default is 10s).

  • VARVIS_BACKOFF_FACTOR_SECONDS: Backoff factor in seconds for retries in case an API request fails. Default is 0.5s.

  • VARVIS_BACKOFF_MAX_TRIES: Maximum number of tries for in case an API request fails (must be at least 1).

Additional environment variables must be set for testing environments. See the Development chapter.

Verifying Installation

To verify that the installation was successful, you can run:

varvis_connector --help

This should display the help message for the command-line interface.