README.md

Python bindings to the OnaData API

This repo contains the sources for the OnaData python client library. You can read more about OnaData here

Installation

pip install git+https://github.com/onaio/onapie.git

OR as a pip editable if you'd like to develop this in parallel with your project:-

pip install -e git://github.com/onaio/onapie.git#egg=onapie

Example Usage

Initialization

from onapie.client import Client
client = Client('https://api.ona.io', username='your_ona_username', password='S00p3rS3kret')

or if you prefer to use your api_token:-

client = Client('https://api.ona.io', api_token='your_ona_api_token')

Working with forms

Upload form:

• From file forminfo_dict = client.forms.create('/path/to/form.xls')
• From URL forminfo_dict = client.forms.create('/path/to/form.xls')

Get form:

• Info forminfo_dict = client.forms.get('form_pk')
• Representation json_form_repr = client.forms.get('form_pk', 'JSON')

List forms:

• Full list form_list = client.forms.list()

Working with Data

Endpoints:

• List all data endpoints data_endpoints = client.data.list_endpoints()

Get submitted data for a given form:

• All: form_data_list = client.data.get(form_pk)
• Single: form_datum = client.data.get(form_pk, datum_id)
• By tags: form_data_list = client.data.get(form_pk, None, tag1, tag2, tag3, tag4)
• By query:- form_data_list = client.data.get(form_pk, None, param1=value1, param2=value2 )

Contributing

• [Fork and] create a branch named according to the feature you want to work on
• Clone your new repo & create a virtualenv for it
• Install the dev dependencies: pip install -r dev-requiremets.txt
• Setup the pre-commit Hook: ln -s ../../pre-commit.sh .git/hooks/pre-commit
• Contribute/Develop/Hack
• Send a pull request against the develop branch