Skip to main content

A Python wrapper for the RCSB Protein Data Bank (PDB) API

Project description

PyPDB

A Python 3 toolkit for performing searches with the RCSB Protein Data Bank (PDB). This can be used to perform advanced searches for PDB IDs matching various criteria, as well as to look up information associated with specific PDB IDs. This tool allows standard operations that can be perfomed from within the PDB website (BLAST, PFAM lookup, etc.) to be performed from within Python scripts.

If you use this module for any published work, please consider citing the accompanying paper

  Gilpin, W. "PyPDB: A Python API for the Protein Data Bank."
  Bioinformatics, Oxford Journals, 2016.

Installation

Install using pip:

$ pip install pypdb

To install the development version, which contains the latest features and fixes, install directly from GitHub using

$ pip install git+https://github.com/williamgilpin/pypdb

If you need to install directly from setup.py,

$ python setup.py install

Test the installation, and check that the code successfully connects to the PDB, navigate to the root directory and run

$ pytest

This code has been designed and tested for Python 3.

Usage

PDB Text Search

This package can be used to get lists of PDB IDs associated with specific search terms, experiment types, structures, and other common criteria. To use the simple API, see the examples in demos/demos.ipynb. For advanced search and query logic, see the examples in search/EXAMPLES.md.

PDB Data Fetch

Given a list of PDBs, this package can be used to fetch data associated with those PDBs, including their dates of deposition, lists of authors and associated publications, their sequences or structures, their top BLAST matches, and other query-specific attributes like lists of a ligands or chemical structure. To use the simple API, see the examples in demos/demos.ipynb. For advanced search and query logic, see the examples in data/EXAMPLES.md.

Issues and Feature Requests

If you run into an issue, or if you find a workaround for an existing issue, we would very much appreciate it if you could post your question or code as a GitHub issue.

If posting a feature request, please check that your request is possible using the current GUI on current RCSB website. If so, please perform your search, and then click the link that says JSON in the upper right hand corner of the Advanced Search box. Please post that JSON code with your feature request.

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

pypdb-2.4.tar.gz (33.2 kB view details)

Uploaded Source

Built Distribution

pypdb-2.4-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file pypdb-2.4.tar.gz.

File metadata

  • Download URL: pypdb-2.4.tar.gz
  • Upload date:
  • Size: 33.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pypdb-2.4.tar.gz
Algorithm Hash digest
SHA256 2e865f9cb41c789d78988a73e12d2e329a50d65f28da26d2011202073fde7365
MD5 22d5fbd72b7abcc87a194e94a5e5df9b
BLAKE2b-256 64848df3a471ad6f05ae1fe57ea119072559a0d9448f7c87f95325c777932208

See more details on using hashes here.

File details

Details for the file pypdb-2.4-py3-none-any.whl.

File metadata

  • Download URL: pypdb-2.4-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for pypdb-2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 86aaed60889e480430e9aaed362eeb4469d9bd65b48323ecf34034d6bb219391
MD5 7956bb0f071ea353059f9193b7ad36a5
BLAKE2b-256 590a42903eb57c4d5ee9057533bfa05a81d178896ac18f227e142e0d118b18c7

See more details on using hashes here.

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