Skip to main content

Open Data Stack (odctl)

CI Status PyPI Version Python Versions License

Run an open data stack on your machine, with its services already connected, from one command.

odctl architecture

odctl is a command-line tool that runs an open data stack on your machine with Docker Compose: Kafka, Flink, Spark, Iceberg, Trino, ClickHouse, MLflow, Feast, Airflow and more. You name the profiles you want, such as kafka-lite or airflow, and odctl starts them together with the services they depend on.

To see why it exists and how it differs from a Compose file of your own, read Why odctl.

Documentation: jaehyeon.me/odctl. It covers every profile with its ports, images and memory limits, the CLI reference, guides and troubleshooting.

Installation

odctl needs Docker running and Python 3.10 or later. Requirements says how much memory to give Docker. Install odctl into its own environment:

uv tool install odctl
# or
pipx install odctl

Quick Start

These commands create a workspace, list the profiles, start three of them and stop everything:

odctl init                    # copy the compose files and settings into ./.odctl
odctl list                    # show the profiles
odctl up kafka-lite flink-lite spark-lite
odctl down --all

odctl up starts the profiles each one depends on first, here PostgreSQL, SeaweedFS (S3) and the Iceberg REST catalog. See Getting Started for more.

Installing odctl, previewing what flink-lite starts, starting kafka-lite, listing the containers and stopping them

Commands

Each command has its own section in the CLI reference, with its options and examples. The Example column links to a page that runs the command and shows its output, and Getting Started runs them in order on one profile.

Command Use it to Example
odctl list See every profile and what it runs, as a table or, with --json, as JSON Getting Started
odctl explain See a profile's services, images, ports and the profiles it depends on, as a panel or, with --json, as JSON Getting Started
odctl ps See the running containers, their health and their ports, as a table or, with --json, as JSON Getting Started
odctl info Check the installed odctl version and whether Docker is reachable; with --json, also the image tag, the workspace and odctl's own images Getting Started
odctl init Copy the compose files and settings into .odctl, so you can edit them Getting Started
odctl pull Download a profile's images before you start it How It Works
odctl up Start profiles and the profiles they depend on Getting Started
odctl down Stop profiles and remove their containers Getting Started
odctl logs Read the logs of a profile's containers Getting Started
odctl restart Restart a profile's containers and keep them Getting Started
odctl recreate Replace a profile's containers, to apply an edit to a compose file or .env How It Works
odctl mcp Give an AI agent odctl's commands as MCP tools; needs the mcp extra MCP Server

Roadmap

odctl follows semantic versioning from 1.0, so a later 1.x release does not break a project that pins odctl>=1.0,<2; What Stays Stable in 1.x lists what that covers. The next release adds lineage and alert rules. The roadmap page shows each step in order.

Blog posts about odctl and the projects built on it are tagged odctl on jaehyeon.me.

Projects that use odctl:

  • benchtop: hands-on data engineering and machine learning demos that run locally, each on the odctl stack.
  • desflow (docs): a SimPy library for simulations that stream to Kafka, PostgreSQL, Redis and Iceberg; its examples and integration tests run their infrastructure with odctl.
  • agentic-analytics-system: conversational analytics over an Iceberg lakehouse, with Trino, Iceberg and object storage started by odctl.

Contributing

Pull requests are welcome. CONTRIBUTING.md explains how to set up the repository, run the tests, add a profile or a command, and write the docs.

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.

Metadata

Release files for odctl 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for odctl 1.7.0
File Size Uploaded Provenance Actions
odctl-1.7.0.tar.gz 1.3 MB With provenance Details for odctl-1.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for odctl 1.7.0
File Interpreter ABI Platform Actions
odctl-1.7.0-py3-none-any.whl Python 3 none any Details for odctl-1.7.0-py3-none-any.whl

Total release size: 1.5 MB

Release files / odctl-1.7.0.tar.gz

Download URL odctl-1.7.0.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
32481833685f72349c71fcf0ed56b050daa3c43b1da09c64379c25d2eca69e76
BLAKE2b-256 checksum
How to use checksums
e1106ec5ef32a3115b19d8901515c4df315591369241f520982c5cc020a351c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Release files / odctl-1.7.0-py3-none-any.whl

Download URL odctl-1.7.0-py3-none-any.whl
Size 196.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
46c6ea4b09ab46d169b89d5e58b26f2b8e846ce2b2d36bf87d875e7fc25b33c7
BLAKE2b-256 checksum
How to use checksums
789c6913ada181379b44b1fc49205f6a08702327ce1734ba89a52c9a8539b807
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Security for odctl 1.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for odctl-1.7.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.7.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page