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.

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.7.0.tar.gz (355.3 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.7.0-py3-none-any.whl (53.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for orcheo-0.7.0.tar.gz
Algorithm Hash digest
SHA256 d8bae881ec859bfe6afade6c2d5bee1f0fb1f413319e614d2a96cb6ea349f505
MD5 1e70f1afcc84886be329ff35941d9bec
BLAKE2b-256 815eee05aa802b1c5a247238c3e1e410336cc52c1360e085576b09d6faaeca50

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: orcheo-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 53.2 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 91e015dbc21c161d40bc3ba78d13d704f1ab648f8094748c4768f3828afa2786
MD5 515911cec81261eb384daf0ec6d0c14d
BLAKE2b-256 1990bb427ffa9864f1b808794ff5b2f4ce89a0a1ff3f522e0c8668869c0ba77e

See more details on using hashes here.

Provenance

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