Requirements

For pycaprio to be able to access the API, you will need the API to be activated and have a user with the ROLE_REMOTE role assigned. You can find more information on how to achieve this here.

Creating the pycaprio client

The pycaprio client requires the inception host and the username and password of the remote user you want to use.

You can specify this information either by using environment variables or by explicitly passing the values to the client as arguments:

Environment variables (preferred way)

export INCEPTION_HOST=http://your-inception-host.com
export INCEPTION_USERNAME=remote-user
export INCEPTION_PASSWORD=password

And then in your python code:

from pycaprio import Pycaprio
client = Pycaprio()

Passing the values as parameters

from pycaprio import Pycaprio
client = Pycaprio("http://your-inception-host.com", authentication=("remote-user", "password"))