Skip to main content

Create peptide PDB files with specified geometry

Project description

PeptideBuilder: A simple Python library to generate model peptides.

Matthew Z. Tien, Dariya K. Sydykova, Austin G. Meyer, and Claus O. Wilke

PyPI version PyPI - Downloads PyPI - License Build Status Coverage Status

Installation

You can install PeptideBuilder with pip:

pip install PeptideBuilder

PeptideBuilder has one required dependency: Biopython

Examples

For example usage, we encourage you to checkout the scripts in the examples folder and in the tests folder. The examples folder contains two scripts showing typical usage. The script simpleExample.py is a brief example script demonstrating basic use of the PeptideBuilder library. The script evaluation.py reproduces the results presented in Table 1 of Tien et al. (2013).

The file test_PeptideBuilder.py in tests contains extensive tests for the various functions provided by this library and may also be useful if you're looking for example usage.

Misc

The software is provided to you under the MIT license (see file LICENSE). The most up-to-date version of this software is available at https://github.com/clauswilke/PeptideBuilder.

To test whether your installation works properly, run pytest in the top-level project folder.

Contributing

Pull requests are welcome on GitHub. However, to be accepted, contributions must:

  1. Be styled with black
  2. Be linted with pylint
  3. Be type-checked with mypy
  4. Pass the pytest unit tests

Thus, before contributing code make sure the following commands exit without errors when run from the root directory of the Peptide Builder project:

  • pytest
  • black .
  • mypy PeptideBuilder/
  • pylint --rcfile=setup.cfg PeptideBuilder/

Reference: M. Z. Tien, D. K. Sydykova, A. G. Meyer, C. O. Wilke (2013). PeptideBuilder: A simple Python library to generate model peptides. PeerJ 1:e80.

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

PeptideBuilder-1.1.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

PeptideBuilder-1.1.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file PeptideBuilder-1.1.0.tar.gz.

File metadata

  • Download URL: PeptideBuilder-1.1.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for PeptideBuilder-1.1.0.tar.gz
Algorithm Hash digest
SHA256 047cd04f0776beacf75e860fe398b0aa81ec4213c94a50b476c4793076530e3a
MD5 5341e4f1e9bdd1b64c99e8746bba78b9
BLAKE2b-256 8971a9bdfd852cc65acf8c721c4ca0717d2531ec319987f5c3a5895f04ca41ec

See more details on using hashes here.

File details

Details for the file PeptideBuilder-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: PeptideBuilder-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for PeptideBuilder-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a0a26117bbaec96acca62aa37f3630f8bf2f3fb531c9b372b6be8745c966abdf
MD5 51620c608ecc21eccc0d9b2c2bc964be
BLAKE2b-256 152ab67ef366046ac1a9ccb7ec68571da07fb2ac5eec2ad40f8a81654949a347

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