Skip to main content

Python client for the OmniPath web service

Project description

PyPI Downloads CI Documentation Coverage

Python client for the OmniPath web service


You can install omnipath by running:

pip install omnipath

The OmniPath database

OmniPath is a database of:

  • Protein-protein, TF target and miRNA-mRNA interactions

  • Enzyme-PTM relationships

  • Protein complexes

  • Annotations of protein function, structure, localization, expression

  • Intercellular communication roles of proteins

To learn more about OmniPath, you can visit its website, or read our recent preprint or our first paper from 2016, especially its supplementary material.

The Python client

The data is available through a web service hosted on this website. This repository hosts a Python package for querying this web service and downloading data into data frames or dictionaries.

The Python package for OmniPath is pypath, isn’t it?

pypath is a tool for building the OmniPath databases in a fully customizable way. We recommend to use pypath if you want to:

  • Tailor the database building to your needs

  • Include resources not available in the public web service

  • Use the rich Python APIs available for the database objects

  • Make sure the data from the original sources is the most up-to-date

  • Use the methods in pypath.inputs to download data from resources

  • Use the various extra tools in pypath.utils, e.g. for identifier translation, homology translation, querying Gene Ontology, working with protein sequences, processing BioPAX, etc.

Is there an R client?

Yes there is. The R/Bioconductor package OmnipathR you may find on GitHub or in Bioconductor. The R client currently supports all features of the web service.


We even have a Cytoscape plug-in. With the plug-in you are able to load networks into Cytoscape and access certain (not all) annotations of the proteins.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omnipath-1.0.8.tar.gz (1.9 MB view hashes)

Uploaded source

Built Distribution

omnipath-1.0.8-py3-none-any.whl (68.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page