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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
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
File details
Details for the file sapporo-2.2.6.tar.gz.
File metadata
- Download URL: sapporo-2.2.6.tar.gz
- Upload date:
- Size: 11.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
21d5dcc633bbbfcc33ea8b0966bfeab6dd588e0df2b4336c67668901e4b1bf66
|
|
| MD5 |
98adedae54ecee915e942d3f1206909d
|
|
| BLAKE2b-256 |
f56476c70ecfa5c8f4a0f689bbe285fbb399f5c6a2d91e13d833fa910b9f685d
|
File details
Details for the file sapporo-2.2.6-py3-none-any.whl.
File metadata
- Download URL: sapporo-2.2.6-py3-none-any.whl
- Upload date:
- Size: 70.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
774ff20f55b59b185142730eeb649ea95a63bec1917df6bdbc1fab0762fa57bf
|
|
| MD5 |
1aaec0e4ddeae114b1d76590d26d1823
|
|
| BLAKE2b-256 |
c6a00535f6aa7d351a9d1537733d8595d38cc0dd05614bc50c2431a614568b47
|
