Skip to main content

SHEPHARD

Sequence-based Hierarchical and Extendable Platform for High-throughput Analysis of Region of Disorder

Current major version: 0.2.3 (July 2026)

CI Documentation Status codecov PyPI Python versions Downloads License: MIT Last commit DOI

About

SHEPHARD is a Python toolkit for integrative proteome-wide analysis. It was written by Garrett Ginell and Alex Holehouse.

SHEPHARD enables you to read in protein sequence data and annotate it with different types of sequence annotations (Sites, Domains, and Tracks).

Installation

Copy and paste into your terminal:

pip install shephard

This installs the current stable release candidate from PyPi. SHEPHARD is pure Python and requires Python 3.10 or higher; the only runtime dependencies are numpy and protfasta, both installed automatically.

Installation from GitHub

Copy and paste into your terminal:

pip install shephard@git+https://github.com/holehouse-lab/shephard.git

This installs the current bleeding-edge version directly from GitHub.

Documentation

Online documentation for SHEPHARD can be found here:

https://shephard.readthedocs.io/en/latest/

Tutorial Examples

Examples and Google Colab tutorials can be found here:

https://github.com/holehouse-lab/shephard-colab

Runnable demo notebooks also ship with the package in demo/, including a walkthrough of the UniProt API.

Status

SHEPHARD is fully released and in active use, and the SHEPHARD paper is out in Bioinformatics.

Citation

If you use SHEPHARD in your work, please cite:

Ginell, G. M., Flynn, A. J. & Holehouse, A. S. SHEPHARD: a modular and extensible software architecture for analyzing and annotating large protein datasets. Bioinformatics 39, btad488 (2023). https://doi.org/10.1093/bioinformatics/btad488

In BibTeX:

@article{ginell2023shephard,
  author  = {Ginell, Garrett M. and Flynn, Aidan J. and Holehouse, Alex S.},
  title   = {{SHEPHARD}: a modular and extensible software architecture for analyzing and annotating large protein datasets},
  journal = {Bioinformatics},
  volume  = {39},
  number  = {8},
  pages   = {btad488},
  year    = {2023},
  doi     = {10.1093/bioinformatics/btad488}
}

This repository also includes a CITATION.cff file, so GitHub's "Cite this repository" button will generate the citation for you in whichever format you need.

Roadmap

SHEPHARD is the base code for a large body of sequence-based bioinformatic tools developed by the Holehouse lab. These include:

Together, these tools form the backbone of our informatics infrastructure, and SHEPHARD provides direct or indirect API access to each of them (and various other tools).

Change log

The full change log lives in CHANGELOG.md.

Copyright

Copyright (c) 2019-2026, Garrett M. Ginell and Alex S. Holehouse - Holehouse lab

Download files

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

Source Distribution

shephard-0.2.4.tar.gz (230.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shephard-0.2.4-py3-none-any.whl (263.0 kB view details)

Uploaded Python 3

File details

Details for the file shephard-0.2.4.tar.gz.

File metadata

  • Download URL: shephard-0.2.4.tar.gz
  • Upload date:
  • Size: 230.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for shephard-0.2.4.tar.gz
Algorithm Hash digest
SHA256 df034d1dd0ebc4f02ae0c28cb15e4af31709b5afa2e1e420444aaa011b58c017
MD5 a2f234c56b08c14c6d4da1fcc76d542f
BLAKE2b-256 4ea8d92e021bf1cb6842f6a5b9f2afedcd6ce0f76af18564ff5f0f616b0561eb

See more details on using hashes here.

File details

Details for the file shephard-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: shephard-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 263.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for shephard-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4b401693230ecacd616a3fbbbb315861fbdb44b99350483c1f45e74395c9dcfe
MD5 14d2e727d153b7887d645b5b3fc2b423
BLAKE2b-256 fbff81b203ad8c88fdf57649b15994bdf04aabd9276e85205374749450e2a660

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.2.4 This release

2 files

0.2.3

2 files

0.2.2

1 file

0.2.1

1 file

0.2.0

1 file

0.1.21

1 file

0.1.20

1 file

0.1.17

1 file

0.1.16

1 file

0.1.15

1 file

0.1.14

1 file

0.1.12

1 file

0.1.8

1 file

0.1.7

1 file

0.1.5

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page