sapporo-service
The sapporo-service is a standard implementation of the Global Alliance for Genomics and Health (GA4GH) Workflow Execution Service (WES) API specification. WES provides a standardized way to submit, monitor, and retrieve results from computational workflows across different platforms.
The service builds on GA4GH WES 1.1.0 with additional capabilities defined in the sapporo-wes-2.1.0 specification, including output file downloads, RO-Crate metadata generation, run deletion, and JWT authentication. Each workflow engine runs inside its own Docker container, so the service does not require any engine-specific installation.
Supported Workflow Engines
Quick Start
docker compose up -d
curl localhost:1122/service-info
See the Getting Started guide for a complete walkthrough including workflow submission.
Documentation
Full documentation is available at https://sapporo-wes.github.io/sapporo-service/.
- Getting Started - First-time tutorial: start the service, submit a workflow, retrieve results
- Installation - Install with pip or Docker, volume mount configuration
- Configuration - CLI options, environment variables, executable workflows
- WES Compatibility - GA4GH WES 1.1.0 and sapporo-wes 2.x compatibility matrix
- Authentication - JWT authentication, sapporo/external mode
- Architecture - run.sh abstraction, run directory, SQLite, RO-Crate, code structure
- RO-Crate - RO-Crate metadata generation specification
- Development - Development environment, testing, release process
- Agent Skill - LLM/agent reference: submit workflows, poll status, retrieve outputs via
curl - Agent Quick Reference - Essential 4 commands in ~40 lines
License
This project is licensed under the Apache-2.0 license. See the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for sapporo 2.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sapporo-2.4.2.tar.gz | 11.9 MB | Without provenance | Details for sapporo-2.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sapporo-2.4.2-py3-none-any.whl | Python 3 | none | any | Details for sapporo-2.4.2-py3-none-any.whl |
Total release size: 11.9 MB
Release files / sapporo-2.4.2.tar.gz
| Download URL | sapporo-2.4.2.tar.gz |
|---|---|
| Size | 11.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d2cdd3bc23140384a00bfa4b9c44a785753330a019f0ca64d25aec5bdcb9011
|
|
BLAKE2b-256 checksum How to use checksums |
ffbe41cf854ff9f79ad4caee7ea5339268566d25a62e77478597141055b78aef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / sapporo-2.4.2-py3-none-any.whl
| Download URL | sapporo-2.4.2-py3-none-any.whl |
|---|---|
| Size | 81.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b97ca1002ef10a76db9412fd328e09715e6886160bfe04725b7ce4e921f2133b
|
|
BLAKE2b-256 checksum How to use checksums |
5dbefa8c46673b3549115fdc2b8fa988902ab4093e6c436909ff580573919b1e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for sapporo 2.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
