b3ds-d01 / ga4gh-client Goto Github PK

This is a client library for using the Global Alliance for Genomics and Health (GA4GH) API. This library provides an easy Python programming interface to access GA4GH compliant servers such as the 1kgenomes.ga4gh.org server.

Installation

pip install ga4gh-client

To install the latest alpha release use

pip install --pre ga4gh_client

This installs both the client command line utility and the GA4GH client programming library.

To demonstrate the CLI try:

ga4gh_client datasets-search http://1kgenomes.ga4gh.org

To access the programming API you can use a Python console:

>>> from ga4gh.client import client
>>> c = client.HttpClient("http://1kgenomes.ga4gh.org")
>>> datasets = list(c.search_datasets())
>>> print datasets
[id: "WyIxa2dlbm9tZXMiXQ"
name: "1kgenomes"
description: "Variants from the 1000 Genomes project and GENCODE genes annotations"
]
>>>

• For more examples of using the GA4GH client visit this iPython notebook.
• For more information about GA4GH see the GA4GH website.
• Full documentation is available at read-the-docs.org.
• For a quick start with the GA4GH API, please see our demo.
• To configure and deploy the GA4GH server in production please see the installation page.
• If you would like to contribute to the project, please see the development page.