agavepy 0.2

SDK for Agave

A simple Python binding for the Agave API.

Installation

Install from PyPI:

pip install agavepy

Using agavepy in Docker

This repository includes a Dockerfile and a docker-compose.yml file, which allows a zero installation version of agavepy.

The only requirement is Docker and docker-compose, most likely already installed in your system.

Then, clone this repository and execute docker-compose as follows:

$ git clone https://bitbucket.org/taccaci/agavepy.git
$ cd agavepy
$ docker-compose build
$ docker-compose up

(a bug in docker-compose is preventing to run just up. The steps build and up have to be done separately.) Navigate to http://localhost:8888 and access the Jupyter notebook with password agavepy. The notebook Example.ipynb contains a full example of use.

Quickstart

The first step is to create an agave Python object pointing to your tenant:

>>> from agavepy.agave import Agave
>>> my_agave = Agave(api_server='https://agave.iplantc.org',
...                  username='myusername', password='mypassword')

Once the object is instantiated, interact with it according to the methods in the API documentation.

For example, create a new client with:

>>> my_agave.clients.create(body={'clientName': 'my_client'})

Access any endpoint with:

>>> my_agave.systems.list()
>>> my_agave.jobs.manage(...)

Once a client is created, it is used by default to access the API.

To make use of an existing client, pass the client’s credentials into the Agave constructor:

>>> from agavepy.agave import Agave
>>> my_agave = Agave(api_server='https://agave.iplantc.org',
...                  username='myusername', password='mypassword', client_name='my_client', api_key='123', api_secret='abc')

Alternatively, the SDK will attempt to recover the client credentials from the client name if they are stored in the user’s .agavepy file, in which case just passing the client_name will suffice:

>>> from agavepy.agave import Agave
>>> my_agave = Agave(api_server='https://agave.iplantc.org',
...                  username='myusername', password='mypassword', client_name='my_client')

License

Agavepy is licensed under the MIT license.

Swagger.py is copyright of Digium, Inc., and licensed under BSD 3-Clause License.