Daylily Ursa beta analysis API
Project description
daylily-ursa
Daylily Ursa is the analysis execution, review, artifact-linking, and result-return service. It sits downstream of wet-lab execution and upstream of customer-visible delivery, coordinating analysis ingest, staged sample manifests, cluster launch jobs, review state, Dewey artifact linkage, and Atlas return.
Ursa owns:
- analysis ingest records linked to sequencing context
- worksets, manifests, staging jobs, analysis jobs, and review state
analysis_samples_manifestgeneration from editor inputs, S3 references, and thedaylily-ectemplate- Dewey artifact-link and registration flows for analysis inputs and outputs
- Atlas result return after approval
Ursa does not own:
- customer portal routes
- storage policy authority
- file or file-set identity
- generic shared DB or auth lifecycle
Current Runtime Contract
The current package and runtime contracts are intentionally pinned:
daylily-ephemeral-cluster==2.1.11daylily-tapdb==6.0.8daylily-auth-cognito==2.1.5cli-core-yo==2.1.1zebra_day==6.0.1- Python dependencies live only in
pyproject.toml environment.yamlis limited to Python, pip, setuptools, and system/runtime packages
The public CLI is ursa, built with a cli-core-yo v2 root spec. Several command callbacks still use Typer annotations internally, but command registration, JSON policy, runtime guards, and config/env scaffolding are managed through cli-core-yo.
Component View
flowchart LR
Ingest["analysis ingest"] --> Ursa["Ursa API and GUI"]
Bloom["Bloom run context"] --> Ursa
Ursa --> Dewey["artifact resolution and registration"]
Ursa --> EC["daylily-ec staging and workflow launch"]
Ursa --> Atlas["approved result return"]
Ursa --> TapDB["TapDB persistence"]
Prerequisites
- Python 3.11+
- Conda shell environment
- local PostgreSQL/TapDB runtime for local development
- configured Cognito values for authenticated GUI startup
- API keys and base URLs for live Bloom, Dewey, or Atlas integration
- Playwright browser binaries for E2E browser flows
Getting Started
Always activate from the repo root with an explicit deployment name:
source ./activate <deploy-name>
The activation script creates the deployment-scoped conda env only when missing, activates it, and runs one editable install on first create. It does not install extra dependency groups, copy config, export runtime settings, install browser binaries, or run tool checks.
Typical local startup:
ursa config init
ursa db build --target local
ursa server start --port 8913
ursa server start uses the shared TLS resolver by default. Pass --no-ssl for HTTP-only local testing, or --cert and --key to use an explicit deployment-scoped certificate pair.
Useful CLI checks:
ursa --help
ursa --json version
ursa env validate
ursa server --help
ursa server status
Configuration
ursa config init creates the deployment-scoped YAML config under the cli-core-yo XDG app directory for ursa-<deploy-name>. The checked-in example is config/ursa-config.example.yaml.
Important runtime fields:
ursa_internal_output_bucketis required at app startup.tapdb_client_id,tapdb_database_name,tapdb_config_path, andtapdb_envselect the TapDB namespace and runtime.- Cognito Hosted UI values must be present in YAML for authenticated GUI startup:
cognito_user_pool_id,cognito_app_client_id,cognito_region,cognito_domain,cognito_callback_url, andcognito_logout_url. bloom_base_url,atlas_base_url, and Dewey settings control peer-service integrations.ursa_tapdb_mount_enabledandursa_tapdb_mount_pathcontrol the embedded TapDB admin mount.
Use ursa ... for Ursa-owned runtime operations. Use tapdb ... only where Ursa delegates TapDB lifecycle work, use daycog ... only for shared Cognito lifecycle, and use daylily-ec ... only for the execution-plane operations Ursa delegates.
API And Workflow Surface
Core API surface:
GET /healthzandGET /readyzexpose process readiness.GET /api/v1/mereturns the authenticated user context./api/v1/analysesmanages analysis ingest, status, review, artifacts, and return./api/v1/worksetsmanages GUI-ready workset records./api/v1/manifestscreates manifests and writes generatedmetadata.analysis_samples_manifest./api/v1/manifests/{manifest_euid}/downloadreturns the generatedanalysis_samples.tsv./api/v1/staging-jobsdefines and runs sample staging throughdaylily-ec samples stage./api/v1/analysis-jobsdefines, launches, refreshes, and reads analysis workflow jobs./api/v1/clustersand/api/v1/clusters/jobsexpose cluster creation, inspection, dry-run delete planning, and cluster job state./api/v1/bucketsmanages linked S3 buckets and object browsing/upload helper routes./api/v1/user-tokensand/api/v1/admin/user-tokensmanage Ursa user tokens.
Manifest creation rejects caller-supplied generated manifest metadata. Ursa derives analysis_samples_manifest from editor_analysis_inputs or S3 input references, using the installed daylily-ephemeral-cluster==2.1.11 template.
Staging jobs run against an existing manifest and capture the remote FSx stage directory plus stdout/stderr. Analysis jobs may either stage from a reference_bucket or reuse a completed staging_job_euid whose tenant, workset, manifest, state, and stage_dir match the request.
Atlas result return is allowed only after approval. Ursa sends opaque EUIDs and Dewey artifact EUIDs to Atlas and persists the Atlas response on the analysis record.
TapDB Admin Mount
When enabled, Ursa mounts the TapDB admin ASGI app under /admin/tapdb. Mounted mode:
- requires explicit TapDB env and config path
- forwards the Ursa-selected TapDB env, client ID, and namespace into the embedded app
- gates access with
X-API-Keymatchingursa_internal_api_key - injects a mounted TapDB admin identity into the forwarded ASGI scope
- does not mutate TapDB admin auth environment variables
- fails app startup if the mount is enabled but the TapDB admin app cannot be imported
Set ursa_tapdb_mount_enabled: false to skip the mount in environments that do not install the TapDB admin surface.
Development Notes
Useful checks:
source ./activate <deploy-name>
pytest -q
ruff check .
ruff format --check .
git diff --check
Focused contract checks:
pytest tests/test_activation_metadata.py tests/test_cli_registry_v2.py tests/test_console_scripts.py -q
The repo uses setuptools-scm for versions. Release tags are bare numeric semver annotated tags.
Sandboxing
- Safe: docs work, tests,
ursa --help,ursa --json version, local-only runtime checks - Local-stateful:
ursa config initand local TapDB bootstrap paths - Requires extra care: live Atlas/Bloom/Dewey integrations, cluster lifecycle operations, and deployed environment changes
Current Docs
- Docs index
- Google OAuth default
- Ursa-Atlas return contract
- TapDB admin mount status
- Conformance audit
References
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
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 daylily_ursa-2.0.5.tar.gz.
File metadata
- Download URL: daylily_ursa-2.0.5.tar.gz
- Upload date:
- Size: 2.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eab4474339005876167728b328d4ec90ce1a7a248394d627bef3bf0f392e5018
|
|
| MD5 |
7fd00f13ef7886525f1f64b6590b2d2d
|
|
| BLAKE2b-256 |
a65d69e62081575b867a038d83046682c955b6974137bdac91398a4c5f70ab5e
|
File details
Details for the file daylily_ursa-2.0.5-py3-none-any.whl.
File metadata
- Download URL: daylily_ursa-2.0.5-py3-none-any.whl
- Upload date:
- Size: 289.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ef190a6e193dc59c53ed91552347ab6a9152e5ac2f785059a40f827805e290b7
|
|
| MD5 |
1f677fba99abe17e55afaf6c6568bbd5
|
|
| BLAKE2b-256 |
75bc0a0ab8a63b61df2a14d5c9ef5997f03bed4e406324fa57b127237d5fc800
|