Add your description here
Project description
Orcheo
Orcheo is a tool for creating and running workflows.
Repository layout
src/orcheo/– core orchestration engine and FastAPI implementationapps/backend/– deployment wrapper exposing the FastAPI ASGI apppackages/sdk/– lightweight Python SDK for composing workflow requestsapps/canvas/– React + Vite scaffold for the visual workflow designer
Quick start
The project ships with everything needed to spin up the FastAPI runtime on SQLite for local development.
-
Install dependencies
uv sync --all-groups
-
Seed environment variables
uv run orcheo-seed-env
Pass
-- --forceto overwrite an existing.envfile. -
Run the API server
uv run orcheo-dev-server
-
Verify the setup
uv run orcheo-test
Opening the repository inside VS Code automatically offers to start the included
dev container with uv and Node.js preinstalled. The new quickstart flows in
examples/quickstart/ demonstrate the visual designer and SDK user journeys,
and examples/ingest_langgraph.py shows how to push a Python LangGraph script
directly to the backend importer, execute it, and stream live updates.
See docs/deployment.md for Docker Compose and managed
PostgreSQL deployment recipes.
CLI
Orcheo ships with a LangGraph-friendly CLI for node discovery, workflow inspection, credential management, and reference code generation. Install the workspace dependencies and invoke the CLI via uv:
uv run orcheo --help
Example commands:
uv run orcheo node list– enumerate registered nodes and their metadatauv run orcheo workflow show <workflow-id>– inspect workflows, graph versions, and recent runsuv run orcheo credential create <name> --provider <provider> --secret <value>– manage vault credentialsuv run orcheo code scaffold <workflow-id>– generate Python snippets that trigger workflows via the SDK
Pass --offline to reuse cached metadata when disconnected. See
docs/cli_tool_design.md for roadmap details and
future MCP server integration plans.
Frontend experience plan
The path to a production-quality canvas is captured in
docs/frontend_plan.md, outlining research, design
system development, architectural refactors, and QA milestones for the React
application. Start there when kicking off frontend workstreams so design and
engineering stay aligned.
Workflow repository configuration
The FastAPI backend now supports pluggable workflow repositories so local
development can persist state without depending on Postgres. By default the app
uses a SQLite database located at ~/.orcheo/workflows.sqlite. Adjust the
following environment variables to switch behaviour:
ORCHEO_REPOSITORY_BACKEND: acceptssqlite(default) orinmemoryfor ephemeral testing.ORCHEO_REPOSITORY_SQLITE_PATH: override the SQLite file path when using the SQLite backend.
Refer to .env.example for sample values and to docs/deployment.md for
deployment-specific guidance.
Releasing packages
Follow docs/releasing.md for the step-by-step guide to
version, tag, and publish the orcheo, orcheo-backend, and orcheo-sdk
packages independently via the automated CI workflows.
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 orcheo-0.9.2.tar.gz.
File metadata
- Download URL: orcheo-0.9.2.tar.gz
- Upload date:
- Size: 758.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
28fadb2e8825c334770a5c3f07967bc5b309e10dd24786e30f97aae20532168d
|
|
| MD5 |
02a81439cb5d054ccc115d6d556f0b9b
|
|
| BLAKE2b-256 |
2f9aa1ec29e20d45e7fffaa128e5d394dc5f3248ad917394e074d0d1c966635a
|
Provenance
The following attestation bundles were made for orcheo-0.9.2.tar.gz:
Publisher:
ci.yml on ShaojieJiang/orcheo
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
orcheo-0.9.2.tar.gz -
Subject digest:
28fadb2e8825c334770a5c3f07967bc5b309e10dd24786e30f97aae20532168d - Sigstore transparency entry: 654514304
- Sigstore integration time:
-
Permalink:
ShaojieJiang/orcheo@d0c4948a72291bcbef2daae32ca152eb921552fd -
Branch / Tag:
refs/tags/core-v0.9.2 - Owner: https://github.com/ShaojieJiang
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@d0c4948a72291bcbef2daae32ca152eb921552fd -
Trigger Event:
push
-
Statement type:
File details
Details for the file orcheo-0.9.2-py3-none-any.whl.
File metadata
- Download URL: orcheo-0.9.2-py3-none-any.whl
- Upload date:
- Size: 67.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1cab0b332ef59b7b3c22e9978fa1e7fe3bf81dc3e4698157100e32042cc8cf3c
|
|
| MD5 |
10c181b7adc4a9b31251165bc095547d
|
|
| BLAKE2b-256 |
33b004b53dc9cfe274898111c7db8655a01ba67e8416910e06a0cedda460f86c
|
Provenance
The following attestation bundles were made for orcheo-0.9.2-py3-none-any.whl:
Publisher:
ci.yml on ShaojieJiang/orcheo
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
orcheo-0.9.2-py3-none-any.whl -
Subject digest:
1cab0b332ef59b7b3c22e9978fa1e7fe3bf81dc3e4698157100e32042cc8cf3c - Sigstore transparency entry: 654514317
- Sigstore integration time:
-
Permalink:
ShaojieJiang/orcheo@d0c4948a72291bcbef2daae32ca152eb921552fd -
Branch / Tag:
refs/tags/core-v0.9.2 - Owner: https://github.com/ShaojieJiang
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@d0c4948a72291bcbef2daae32ca152eb921552fd -
Trigger Event:
push
-
Statement type: