Biothings_client.py

Biothings_client.py is a unified python client providing an easy-to-use wrapper for accessing any BioThings API (e.g. MyGene.Info, MyVariant.Info, MyChem.Info, MyDisease.Info). It is the descendent and eventual replacement of both the MyGene.py and MyVariant.py python clients.

Requirements

Python >=3.7

Note

Python 3.6 is still supported with some limitations (e.g. caching feature is not supported in Python 3.6).

Note

Python<=3.5 (including Python 2.7) is no longer supported as of version 0.4.0. The last version supporting Python<=3.5 is 0.3.1.

Installation

  • Option 1. Install from pypi repository using pip:

    pip install biothings_client
    
  • Option 2. Install the latest commit from the github repository using pip:

    pip install -e git+https://github.com/biothings/biothings_client.py#egg=biothings_client
    

    or

    pip install biothings_client@git+https://github.com/biothings/biothings_client.py
    

Optional features / dependencies

  • dataframe support (install using pip install biothings_client[dataframe])

    allows for formatting output from the client queries as a list of pandas DataFrame objects. Requires the following optional dependenies

  • caching support (install using pip install biothings_client[caching])

    allows for local caching of client queries to a sqlite database. Requires the following optional dependenies

Version history

Documentation

Indices and tables