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.

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.8.0.tar.gz (667.5 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.8.0-py3-none-any.whl (63.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for orcheo-0.8.0.tar.gz
Algorithm Hash digest
SHA256 6d7df81af44855c7be35b5c7d084106e3adda6ec65380fe421bc656e3fdbd1ef
MD5 5aa84d388254bc9333e72bac403ee046
BLAKE2b-256 45cd3526244091b26b5d05072d458c1b033dd3ad713e4b3e1bedde59af7dbe64

See more details on using hashes here.

Provenance

The following attestation bundles were made for orcheo-0.8.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.8.0-py3-none-any.whl.

File metadata

  • Download URL: orcheo-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 63.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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f2366f9dc0fa0f4eaa8eeb7d6b0cbdf44a5e7a7a5abada1346c620bc3d82127
MD5 0b46e4ce9e50af51fa34c264e8c2f4ef
BLAKE2b-256 2b7a168418273aff5415352c05824741554f97de6bc7317f9579d180df65435d

See more details on using hashes here.

Provenance

The following attestation bundles were made for orcheo-0.8.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