BIOSERVICES: access to biological web services programmatically¶
Citations: | If you use BioServices, please cite Cokelaer et al, Bioinformatics (2013). See bioinformatics link for details. |
---|
Python version: | Python 2.7, 3.6, 3.7 |
---|---|
Source: | See http://github.com/cokelaer/bioservices. |
Issues: | Please fill a report on github |
Note
Contributions to implement new wrappers are more than welcome. See BioServices github page to join the development, and the Developer Guide on how to implement new wrappers. Although contributors have their names in the header files, you can also look at the Contributors directly.
Overview and Installation¶
Overview¶
BioServices is a Python package that provides access to many Bioinformatics Web Services (e.g., UniProt, KeGG, PDB, etc) as well as a framework to easily implement Web Service wrappers (based on WSDL/SOAP protocol or nowadays mostly REST protocol).
The primary goal of BioServices is to use Python as a glue language to provide a programmatic access to Biological Web Services. By doing so, elaboration of new applications that combine several Web Services should be fostered.
One of the main philosophy of BioServices is to make use of the existing REST or SOAP/WSDL Web Services and therefore existing databases, not to re-invent new databases.
The first release of BioServices provides a wrapping to more than 18 Web Services (more if we consider BioMart and PSICQUIC portals that link to many other Web Services).
Here are only some of Web Services that are available in BioServices (from EBI mostly but not only; NCBI, KEGG, etc):
bioservices.arrayexpress.ArrayExpress |
Interface to the ArrayExpress service |
bioservices.biomodels.BioModels |
Interface to the BioModels service |
bioservices.chembl.ChEMBL |
New ChEMBL API bioservices 1.6.0 |
bioservices.chebi.ChEBI |
Interface to ChEBI |
bioservices.eutils.EUtils |
Interface to NCBI Entrez Utilities service |
bioservices.ensembl.Ensembl |
Interface to the Ensembl service |
bioservices.kegg.KEGG |
Interface to the KEGG service |
bioservices.muscle.MUSCLE |
Interface to the MUSCLE service. |
bioservices.panther.PantherDB |
|
bioservices.pdb.PDB |
Interface to PDB service (new API Jan 2021) |
bioservices.uniprot.UniProt |
Interface to the UniProt service |
bioservices.unichem.UniChem |
Interface to the UniChem service |
bioservices.ncbiblast.NCBIblast |
Interface to the NCBIblast service. |
bioservices.wikipathway.Wikipathway |
Full list is available in the User Guide and Reference here below. Some of the services may be down. BioServices developers are not responsible for the maintenance or failure of underlying services. Generally speaking (and by experience) the services are up most of the time.
Installation¶
BioServices is available on PyPi, the Python package repository. The following command should install BioServices and its dependencies automatically provided you have pip on your system:
pip install bioservices
If not, please see the external pip installation page or pip installation entry. You may also find information in the troubleshootings page section about known issues.
Regarding the dependencies, BioServices depends on the following packages: BeautifulSoup4 (for parsing XML), SOAPpy and suds (to access to SOAP/WSDL services; suds is used by ChEBI only for which SOAPpy fails to correctly fetch the service) and easydev. All those packages should be installed automatically when using pip installer. Since version 1.6.0, we also make use of pandas and matplotlib to offer some extra functionalities.
User guide¶
- 1. Quick Start
- 2. Tutorials
- 3. Combining BioServices with external tools
- 4. Developer Guide
- 5. Others
- 6. suds and client auth
- 7. How to include tests ?
- 8. Gallery
- 9. NoteBooks
- 10. Utilities
- 11. Services
- 11.1. ArrayExpress
- 11.2. BiGG
- 11.3. BioDBnet
- 11.4. BioGrid
- 11.5. BioMart
- 11.6. BioModels
- 11.7. ChEBI
- 11.8. ChEMBL
- 11.9. ChemSpider
- 11.10. Clinvitae
- 11.11. COG
- 11.12. ENA
- 11.13. EUtils
- 11.14. GeneProf
- 11.15. QuickGO
- 11.16. Kegg
- 11.17. HGNC
- 11.18. Intact (complex)
- 11.19. MUSCLE
- 11.20. MyGeneInfo
- 11.21. NCBIblast
- 11.22. OmniPath Commons
- 11.23. Panther
- 11.24. Pathway Commons
- 11.25. PDB/PDBe modules
- 11.26. PRIDE module
- 11.27. PSICQUIC
- 11.28. Rhea
- 11.29. Reactome
- 11.30. Readseq
- 11.31. UniChem
- 11.32. UniProt
- 11.33. DBFetch
- 11.34. Wikipathway
- 12. Applications and extra tools
- 13. References to BioServices on the Web
- 14. FAQS
- 15. Whats’ new, what has changed
- 15.1. Revision 1.8.0 roadmap
- 15.2. Revision 1.7.12 (Jan 2021)
- 15.3. Revision 1.7.11 (Dec 2020)
- 15.4. Revision 1.7.10 (Nov 2020)
- 15.5. Revision 1.7.9
- 15.6. Revision 1.7.8
- 15.7. Revision 1.7.7
- 15.8. Revision 1.7.6
- 15.9. Revision 1.7.5
- 15.10. Revision 1.7.4 (March 2020 Combine/Harmany2020 hackathon)
- 15.11. Revision 1.7.3 (March 2020)
- 15.12. Revision 1.7.2 (March 2020)
- 15.13. Revision 1.7.1 (Feb 2020)
- 15.14. Revision 1.7.0 (Feb 2020)
- 15.15. Revision 1.6.0
- 15.16. Revision 1.5.2
- 15.17. Revision 1.5.1
- 15.18. Revision 1.5
- 15.19. Revision 1.4
- 15.20. Revision 1.3
- 15.21. Revision 1.2
- 15.22. Revision 1.1
- 15.23. Revision 1.1
- 15.24. Revision 1.0
- 15.25. Revision 0.9
- 15.26. Up to Revision 0.5
- 16. Contributors