The ricloud-py client is a straightforward implementation of the ricloud v3 API interface. It also includes some sample implementations of common use-cases, and some basic implementations of data retrieval from 3rd party storage buckets (AWS S3 and Google Cloud Storage).
The simplest way to get the client is to install it from PyPi.
pip install ricloud==3.0.0rc0
You can also get the code from the GitHub repo.
key_token is required to authenticate against the API. If you are an existing customer, contact enterprise support to get a trial key for the ricloud v3 API.
ricloud-py can be configured in two ways:
- Via the
tokenattribute on an imported
import ricloud ricloud.token = '<your key_token>'
- Create a
.ricloud.inifile in your home directory with the following content.
[api] token = <you key_token>
.ricloud.ini file reference for more details.
The client exposes a class for each API resource and a set of methods to interact with them.
>>> import ricloud >>> org = ricloud.Organisation.retrieve() >>> print(org.name) My Organisation >>> org.update(name='Changed Organisation') >>> print(org.name) Changed Organisation
The client includes sample implementations for a number of common interactions.
These can be accessed through the
The iCloud sample implementation offers a quick way to retrieve data from an iCloud account through the command line.
The token used to authenticate against the API's endpoints.
The base url for the API. Default:
How many times to retry a request if it fails due to a server or connection error. Default:
The default output directory for any results downloaded as part of a sample script. If the directory path is relative it will be created relative to the current working directory.
The client will create a User resource when executing sample scripts. The default value for this user's identifier is
ricloud-py, but can be easily customised via this option.
This can be useful to distinguish usage between different developers within the same organisation, for example.
[api] token = <your key_token> url = https://ricloud-api.reincubate.com max_retries = 1 [logging] log_directory = logs log_level = WARNING [samples] output_directory = output user_identifier = ricloud-py