Skip to main content

A CLI for downloading SAbDab data.

Project description

SAbDab CLI

A fast, multithreaded CLI for downloading data from SAbDab (the Structural Antibody Database).

This tool is an alternative to the SAbDab downloader script.

Highlights

  • Concurrent Downloads: High-performance async I/O for rapid data acquisition.
  • 🛡️ Robust Retries: Built-in exponential backoff for transient network issues.
  • 📊 Rich Progress: Beautiful terminal progress bars and informative feedback.
  • 📦 Atomic Writes: Prevents data corruption by using temporary files during downloads.

Installation

With uv (recommended):

uv add sabdab-cli

With pip:

pip install sabdab-cli

Or run directly without installing:

uvx sabdabc download -s summary.csv -o ./data --original-pdb

Usage

You can invoke with sabdab-cli or sabdabc.

Download selected data types for entries in a SAbDab summary file:

sabdab-cli download \
  --summary-file summary.csv \
  --output-path ./data \
  --original-pdb \
  --chothia-pdb \
  --sequences \
  --annotation \
  --threads 10

Available Data Types

Flag Description
--original-pdb Original PDB structures
--chothia-pdb Chothia-renumbered PDB structures
--sequences Sequence FASTA files
--annotation Chothia-numbered sequence annotations
--abangle AbAngle orientation angles
--imgt IMGT annotations

Summary File Format

The --summary-file (or -s) argument should be a TSV or CSV file containing at least the following columns: pdb, Hchain, Lchain, and model. See the test summary file for an example.

Performance Tuning

By default, sabdab-cli uses adaptive concurrency based on your CPU count. You can manually adjust this for your environment:

# High-concurrency mode (e.g., 20 threads)
sabdabc download -s summary.csv -o ./data --original-pdb --threads 20

# Synchronous mode (single thread)
sabdabc download -s summary.csv -o ./data --original-pdb --threads 1

License

MIT

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

sabdab_cli-0.1.0.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

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

sabdab_cli-0.1.0-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file sabdab_cli-0.1.0.tar.gz.

File metadata

  • Download URL: sabdab_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","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 sabdab_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2320b3cb859ac6fbed3337e262d81e3e99d32c2207ec2679836faa5f0f4dfba2
MD5 f385cf461473cb4676d85c0d0177e77d
BLAKE2b-256 1cf3aa39ef7c22abc2b7e598308ab2a0bc743131a1704471359a9fa99015c4c7

See more details on using hashes here.

File details

Details for the file sabdab_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sabdab_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","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 sabdab_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff5c9ec4f6f645fcbe6582ad2de35ed31c57f48b48d67835da2877941a696cb4
MD5 2eb95c738f19aa46eb5bb5268e70dd18
BLAKE2b-256 63c95dc702d1ed9c2565d5bbb64d1c457f97a187fe1f3a6696d940c0de5b71b2

See more details on using hashes here.

Supported by

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