mrhanlon / adamalib

A Python library for using Adama

Adama Library

Adamalib provides a Python library/SDK for interacting with Adama. It is designed to be used as a standalone library in the user's local machine to develop Adama microservices.

Installation

Use pip:

pip install git+git://github.com/Arabidopsis-Information-Portal/adamalib.git

It'll be moved to PyPI as soon as it reaches some stability.

As an alternative, see using adamalib in Docker below.

Using adamalib in Docker

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

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://github.com/Arabidopsis-Information-Portal/adamalib.git
$ cd adamalib
$ docker-compose build
$ docker-compose up

(a bug in docker-compose requires doing the steps build and up separately. In the future, only up will be necessary.)

Navigate to http://localhost:8888 and access the Jupyter notebook with password adamalib. The notebook Example.ipynb contains a full example of use. The notebook Provenance.ipynb contains an example of accessing provenance information from Python.

Note: If you are running on a Mac with boot2docker, substitute localhost by the output of:

$ boot2docker ip

License

Free software: MIT license