Python SDK for the Biotailor bioinformatics pipeline platform
Project description
biotailor
Python SDK for the Biotailor bioinformatics pipeline platform.
Installation
pip install biotailor
Quickstart
from biotailor import BiotailorClient, Pipeline
# 1. Create a client (get your API key from the Biotailor website)
client = BiotailorClient(api_key="btk_xxx.sk_yyy")
# 2. Discover available tools
tools = client.list_tools()
for t in tools:
print(f"{t.toolid}: {t.display_name}")
# 3. Build a pipeline
tool = client.get_tool("fastp-single")
pipeline = (
Pipeline(name="QC my reads", tool=tool)
.set_input("input", "reads.fastq")
.set_param("qualified_quality_phred", 20)
)
# 4. Run and wait
job = client.run_and_wait(pipeline, output_dir="./results")
print(f"Job {job.jobid} finished with status: {job.job_status.value}")
Development
# Install in dev mode
pip install -e ".[dev]"
# Run tests
pytest tests/ -v
# Lint
ruff check src/ tests/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
biotailor-0.1.0.tar.gz
(10.8 MB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
biotailor-0.1.0-py3-none-any.whl
(14.1 kB
view details)
File details
Details for the file biotailor-0.1.0.tar.gz.
File metadata
- Download URL: biotailor-0.1.0.tar.gz
- Upload date:
- Size: 10.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e968a64da662800e2082bd870e9b29521b8b0cdf84d5733d5cd94eb8fed83d40
|
|
| MD5 |
a8768d9d54fef1bf08030696271854d1
|
|
| BLAKE2b-256 |
4c38398f85be7fc15bffbef998146f52eceb0e3478305701dedf74f4cd75bce7
|
File details
Details for the file biotailor-0.1.0-py3-none-any.whl.
File metadata
- Download URL: biotailor-0.1.0-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c3b4c321be3b47926205fa44eb856dae8533b1c810c3fc1941f523987ff75fc5
|
|
| MD5 |
bd41e5329bda794be6967f115536f5e0
|
|
| BLAKE2b-256 |
b84ba937f6c4b06c09d3e591386edf3512eedea7bfffe942bff8f8a21d4f58dc
|