From 88e85a334f22e30667af361faeb4b1e2f18386e2 Mon Sep 17 00:00:00 2001 From: Aditya-Deshwal23 Date: Thu, 26 Mar 2026 17:13:32 +0530 Subject: [PATCH] Added quick start section and improved Graphviz installation instructions --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 47 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e6283d7f0..8743827fe 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,39 @@ under the License. Apache Hamilton (incubating) is a lightweight Python library for directed acyclic graphs (DAGs) of data transformations. Your DAG is **portable**; it runs anywhere Python runs, whether it's a script, notebook, Airflow pipeline, FastAPI server, etc. Your DAG is **expressive**; Apache Hamilton has extensive features to define and modify the execution of a DAG (e.g., data validation, experiment tracking, remote execution). +## Quick Start (2 minutes) + +Get started with Apache Hamilton in just a few lines of code: + +```python +# Step 1: Install (run in terminal) +# pip install sf-hamilton + +# Step 2: Define your functions (nodes in the DAG) +def A() -> int: + return 1 + +def B(A: int) -> int: + return A + 1 + +# Step 3: Execute the DAG +from hamilton import driver + +dr = driver.Driver({}, __name__) +result = dr.execute(["B"]) + +print(result) + +Expected output: {'B': 2} + +## What’s happening? + +Each function becomes a node in the DAG +Dependencies are defined through function parameters +Hamilton automatically builds and executes the dependency graph + +This is the simplest possible pipeline — from here, you can scale to ML workflows, ETL pipelines, and production data systems. + To create a DAG, write regular Python functions that specify their dependencies with their parameters. As shown below, it results in readable code that can always be visualized. Apache Hamilton loads that definition and automatically builds the DAG for you!
@@ -70,19 +103,26 @@ Apache Hamilton brings modularity and structure to any Python application moving # Installation -Apache Hamilton supports Python 3.8+. We include the optional `visualization` dependency to display our Apache Hamilton DAG. For visualizations, [Graphviz](https://graphviz.org/download/) needs to be installed on your system separately. +Apache Hamilton supports Python 3.8+. We include the optional visualization dependency to display our Apache Hamilton DAG. For visualizations, Graphviz needs to be installed on your system separately. -```bash pip install "sf-hamilton[visualization]" -``` +📦 Install Graphviz (required for visualization) + +If you want to visualize DAGs, ensure Graphviz is installed on your system: + +Mac : brew install graphviz -To use the Apache Hamilton UI, install the `ui` and `sdk` dependencies. +Ubuntu : sudo apt-get install graphviz + +Windows : Download and install from: https://graphviz.org/download/ + +⚠️ Make sure Graphviz is added to your system PATH. + +To use the Apache Hamilton UI, install the ui and sdk dependencies: -```bash pip install "sf-hamilton[ui,sdk]" -``` -To try Apache Hamilton in the browser, visit [www.tryhamilton.dev](https://www.tryhamilton.dev/?utm_source=README) +To try Apache Hamilton in the browser, visit [Try Hamilton](https://www.tryhamilton.dev/?utm_source=README) # Why use Apache Hamilton?