Skip to main content

bioclients bioclients logo

Python package for access to online biomedical resources, usually via REST APIs. Modules generally include Client.py for command-line use and Utils.py for integration into other code. With the advent of HTTP web services, first SOAP/XML and then mostly REST/JSON, many online APIs require very similar methods for data search, requests and transforms into usable formats, often TSV.

Modules

Allen • AMP-T2D • Badapple • BindingDb • BioGrid • BiomarkerKB • Bioregistry • BRENDA • CAS • CDC • CFDE • Chem2Bio2RDF • ChEBI • ChEMBL • ChemIdPlus • ClinicalTrials.gov • Disease Ontology • DisGeNet • DNorm • DrugCentral • EMBL-EBI • EnsEMBL • Entrez • FDA • Gene Ontology • GTEx • GWAS Catalog • HUGO • HumanBase • iCite • IDG • JensenLab • LINCS • MaayanLab • Medline • MeSH • MONARCH • MyGene • NCBO • NCATS • OMIM • OncoTree • Open Targets • Panther • PDB • PubChem • PubMed • PubTator • Reactome • RXNorm • STRINGDB • TCGA • TINX • UBKG • UMLS • UniProt • Wikidata • WikiPathways

Miscellaneous utilities: UTIL

Dependencies

  • Python 3.10+
  • Python packages: pandas, requests, yaml, psycopg2, tqdm, sqlalchemy, pyquery, mygene, click, PyMuPDF, py2neo, etc.

Availability and installation

Installing from PyPI

Releases at https://pypi.org/project/bioclients/.

pip install bioclients

Venv environment

It may not be necessary or advantageous to configure an environment for all of bioclients functionality. Specific modules may be supported with venv environments with required dependencies. Module documentation should indicate needed package dependencies. The following steps should create an environment for much of the functionality of bioclients.

  1. mkdir -p $HOME/venv/bioclients
  2. python3 -m venv $HOME/venv/bioclients
  3. source $HOME/venv/bioclients/bin/activate
  4. pip install --upgrade pip
  5. pip install --upgrade bioclients

For additional functionality, more packages can be installed by:

pip install -r pip_requirements.txt

Installing from source

Source at https://github.com/jeremyjyang/bioclients

git clone https://github.com/jeremyjyang/bioclients.git
cd bioclients
python3 -m pip install --upgrade build
python3 -m build

Usage Example

python3 -m bioclients.pubchem.Client -h

Design pattern

Generally each module includes command-line app Client.py which calls functions in a corresponding Utils.py, providing all capabilities by import of the module. Command-line apps not API clients are generally named App.py. Functions can write to an output file or return a Pandas dataframe (if output file unspecified).

Data structures and formats, XML, JSON, and TSV

bioclients is designed to be simple and practical, and XML, JSON and TSV are likewise simple in many respects, yet a great deal of conceptual and technological progress is reflected. XML and JSON can represent arbitrarily complex data objects, comprised of nested lists, dictionaries, and trees of primary types. TSV represents tables of rows and columns, related by common keys, reflecting the development of SQL and relational databases. Transforming JSON to TSV, as these clients generally do, projects data objects to tables useful for many applications (e.g. machine learning).

Metadata

Release files for bioclients 0.2.38

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bioclients 0.2.38
File Size Uploaded
bioclients-0.2.38.tar.gz 224.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bioclients 0.2.38
File Interpreter ABI Platform
bioclients-0.2.38-py3-none-any.whl Python 3 none any Details

Total release size: 569.9 kB

Release files / bioclients-0.2.38.tar.gz

Download URL bioclients-0.2.38.tar.gz
Size 224.6 kB
Tags Source
SHA-256 checksum
How to use checksums
147a46a89c25a9eef2c036d8b0d33dddd7aa5ab8d92f0743df59b292a43892f2
BLAKE2b-256 checksum
How to use checksums
80f01476b9839091b6cce039e767e6fa4c2cf9915cd77410c301d772aed7dd0c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / bioclients-0.2.38-py3-none-any.whl

Download URL bioclients-0.2.38-py3-none-any.whl
Size 345.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8dfc40c26400a50a456d0c7a49b47657df3217faa321d6d1ad6968f62a113e8
BLAKE2b-256 checksum
How to use checksums
73a5f17dc4217633228763d2ba1df85e1c57f9ee02bd07b7734a910d3c62fc72
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.2.38 This release

2 release files

0.2.37

2 release files

0.2.36

2 release files

0.2.35

2 release files

0.2.34

2 release files

0.2.33

2 release files

0.2.30

2 release files

0.2.20

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.15

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.9

3 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.3

2 release files

0.2.0

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

3 release files

0.1.4

3 release files

0.1.3

2 release files

0.1.1

3 release files

0.1.0

3 release files

0.0.9

2 release files

0.0.8

3 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

3 release files

0.0.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page