Skip to main content

Open Data Framework CLI

Scaffolds and runs Open Data Framework projects, and serves them through a UI, an MCP server and a chat window. Depends on opendataframework for the core abstractions (Entity, Repository, Component, Service, Task, Pipeline, Agent, Function, Layer, Context, Project) — see that package for those.

Documentation: https://opendataframework.github.io/odf/


Install

pip install odf                # CLI + scaffolding only
pip install "odf[ui]"          # + UI dev server
pip install "odf[mcp]"         # + MCP server
pip install "odf[ui,chat]"     # + chat window (served by the UI)

odf run starts the UI by default, so most projects want at least odf[ui].


Quickstart

pip install "odf[ui]"
odf init my-project            # or --template data-analytics / data-engineering / data-science / ml / research
cd my-project
odf run                        # UI at http://127.0.0.1:4747

With pip install "odf[ui,mcp,chat]", odf run --mcp --chat adds the MCP server at http://127.0.0.1:4748/mcp and a chat window. The same from Python:

from odf.server import Server

server = Server.from_config("config.toml")
server.start(ui=True, mcp=True, chat=True)
server.wait()  # blocks until Ctrl+C/SIGTERM

What's included

  • CLI — odf init scaffolds a project from a template; odf run starts it.
  • UI — the topology of every component with its actions, a view of each repository's data (table, map, timeseries, image, video, audio, document), and labelling of that data into a plain annotations.json.
  • MCP server — the same actions as MCP tools, plus each agent, function and component's own tools.
  • Chat — a chat window in the UI, backed by a local Ollama model, that acts on the project through the MCP tools.

See the documentation for each, and examples/ for 26 small projects, one concept each.

Metadata

Release files for odf 0.5.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 odf 0.5.0
File Size Uploaded Provenance Actions
odf-0.5.0.tar.gz 230.0 kB Without provenance Details for odf-0.5.0.tar.gz

Built distribution (wheel)

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

Total release size: 497.8 kB

Release files / odf-0.5.0.tar.gz

Download URL odf-0.5.0.tar.gz
Size 230.0 kB
Tags Source
SHA-256 checksum
How to use checksums
65e1a2f6092c1aa84bf57cf26e303d84c54ccc5485f72b6f4b1a55a9891800ff
BLAKE2b-256 checksum
How to use checksums
c27134a5b9d930fde9bb72a029eac51a5bd9d3669e3997da4784949da4ab929a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.13.1 Darwin/24.3.0

Release files / odf-0.5.0-py3-none-any.whl

Download URL odf-0.5.0-py3-none-any.whl
Size 267.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2a44037594c6d773e55f89476bd3fccbf6bfcff5173441933e1d499278006bd1
BLAKE2b-256 checksum
How to use checksums
58bed7133a9f1a0943598ba0bd0c9455d78984b8780956f83269171dad36dcf8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.4.1 CPython/3.13.1 Darwin/24.3.0

Security for odf 0.5.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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

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