skrawcz commented on code in PR #1527:
URL: https://github.com/apache/hamilton/pull/1527#discussion_r3068601695
##########
README.md:
##########
@@ -53,6 +53,40 @@ 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__)
Review Comment:
we should be using the builder pattern
##########
README.md:
##########
@@ -53,6 +53,40 @@ 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}
Review Comment:
this code doesn't work for me.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
