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.

Files for PeptideBuilder, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size PeptideBuilder-1.1.0-py3-none-any.whl (14.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size PeptideBuilder-1.1.0.tar.gz (15.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page