Skip to main content

Add your description here

Project description

Orcheo

CI Coverage PyPI - Core PyPI - Backend PyPI - SDK

Orcheo is a tool for creating and running workflows.

Repository layout

  • src/orcheo/ – core orchestration engine and FastAPI implementation
  • apps/backend/ – deployment wrapper exposing the FastAPI ASGI app
  • packages/sdk/ – lightweight Python SDK for composing workflow requests
  • apps/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.

  1. Install dependencies

    uv sync --all-groups
    
  2. Seed environment variables

    uv run orcheo-seed-env
    

    Pass -- --force to overwrite an existing .env file.

  3. Run the API server

    uv run orcheo-dev-server
    
  4. 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 metadata
  • uv run orcheo workflow show <workflow-id> – inspect workflows, graph versions, and recent runs
  • uv run orcheo credential create <name> --provider <provider> --secret <value> – manage vault credentials
  • uv 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: accepts sqlite (default) or inmemory for 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

orcheo-0.10.0.tar.gz (851.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orcheo-0.10.0-py3-none-any.whl (82.0 kB view details)

Uploaded Python 3

File details

Details for the file orcheo-0.10.0.tar.gz.

File metadata

  • Download URL: orcheo-0.10.0.tar.gz
  • Upload date:
  • Size: 851.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orcheo-0.10.0.tar.gz
Algorithm Hash digest
SHA256 0773e22f44043dbebf959dd301babe92262cad1e2e34732108b59357639a908b
MD5 06be27351d7b6f4cde080e5208deccd2
BLAKE2b-256 0abd5f04558921569fe43376fb9b7b531076b46f1c1b8e5df22f6b2227014832

See more details on using hashes here.

Provenance

The following attestation bundles were made for orcheo-0.10.0.tar.gz:

Publisher: ci.yml on ShaojieJiang/orcheo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file orcheo-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: orcheo-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 82.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for orcheo-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 255743f8c1ef542ac7760c5402349f2272130a5ca0a51ba43171d7e12fbb3a9b
MD5 7e73f0560c4509467b28e15d54e02837
BLAKE2b-256 42efc44d966f0cea49dd9655e42a27ee57fc34f71891024bafbe0b78f66deba5

See more details on using hashes here.

Provenance

The following attestation bundles were made for orcheo-0.10.0-py3-none-any.whl:

Publisher: ci.yml on ShaojieJiang/orcheo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page