apache-hamilton 1.89.0__tar.gz

apache-hamilton-1.89.0/DISCLAIMER

@@ -0,0 +1,10 @@
+Apache Hamilton (incubating) is an effort undergoing incubation at the Apache
+Software Foundation (ASF), sponsored by the Apache Incubator PMC.
+
+Incubation is required of all newly accepted projects until a further review
+indicates that the infrastructure, communications, and decision making process
+have stabilized in a manner consistent with other successful ASF projects.
+
+While incubation status is not necessarily a reflection of the completeness
+or stability of the code, it does indicate that the project has yet to be
+fully endorsed by the ASF.

apache-hamilton-1.89.0/LICENSE

@@ -0,0 +1,255 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+-------------------------------
+
+hamilton/experimental/databackend.py is copied from https://github.com/machow/databackend
+and is licensed under the MIT License.
+
+MIT License
+
+Copyright (c) 2024 databackend contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-------------------------------
+
+contrib/hamilton/contrib/user/skrawcz/customize_embeddings/__init__.py is copied
+from https://github.com/openai/openai-cookbook and is licensed under the MIT License.
+
+MIT License
+
+Copyright (c) 2025 OpenAI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

apache-hamilton-1.89.0/NOTICE

@@ -0,0 +1,5 @@
+Apache Hamilton (Incubating)
+Copyright 2025 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

apache-hamilton-1.89.0/PKG-INFO

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: apache-hamilton
+Version: 1.89.0
+Summary: Hamilton, the micro-framework for creating dataframes.
+Keywords: hamilton
+Author-email: Stefan Krawczyk <stefank@cs.stanford.edu>, Elijah ben Izzy <elijah@dagworks.io>
+Requires-Python: >=3.8.1, <4
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: typing_extensions > 4.0.0
+Requires-Dist: typing_inspect
+Requires-Dist: typer ; extra == "cli"
+Requires-Dist: dask[complete] ; extra == "dask"
+Requires-Dist: dask[array] ; extra == "dask-array"
+Requires-Dist: dask[dataframe] ; extra == "dask-dataframe"
+Requires-Dist: dask[diagnostics] ; extra == "dask-diagnostics"
+Requires-Dist: dask[distributed] ; extra == "dask-distributed"
+Requires-Dist: ddtrace<3.0 ; extra == "datadog"
+Requires-Dist: diskcache ; extra == "diskcache"
+Requires-Dist: fastapi ; extra == "experiments"
+Requires-Dist: fastui ; extra == "experiments"
+Requires-Dist: uvicorn ; extra == "experiments"
+Requires-Dist: sf-hamilton-lsp ; extra == "lsp"
+Requires-Dist: openlineage-python ; extra == "openlineage"
+Requires-Dist: pandera ; extra == "pandera"
+Requires-Dist: pydantic>=2.0 ; extra == "pydantic"
+Requires-Dist: pyspark[pandas-on-spark, sql] ; extra == "pyspark"
+Requires-Dist: ray>=2.0.0 ; extra == "ray"
+Requires-Dist: pyarrow ; extra == "ray"
+Requires-Dist: rich ; extra == "rich"
+Requires-Dist: sf-hamilton-sdk ; extra == "sdk"
+Requires-Dist: slack-sdk ; extra == "slack"
+Requires-Dist: tqdm ; extra == "tqdm"
+Requires-Dist: sf-hamilton-ui ; extra == "ui"
+Requires-Dist: vaex ; extra == "vaex" and ( python_version <= '3.10')
+Requires-Dist: graphviz ; extra == "visualization"
+Requires-Dist: networkx ; extra == "visualization"
+Project-URL: changelog, https://github.com/apache/hamilton/releases
+Project-URL: documentation, https://hamilton.apache.org/en/latest/
+Project-URL: homepage, https://www.tryhamilton.dev/
+Project-URL: issues, https://github.com/apache/hamilton/issues
+Project-URL: slack, https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g
+Project-URL: source, https://github.com/apache/hamilton
+Provides-Extra: cli
+Provides-Extra: dask
+Provides-Extra: dask-array
+Provides-Extra: dask-dataframe
+Provides-Extra: dask-diagnostics
+Provides-Extra: dask-distributed
+Provides-Extra: datadog
+Provides-Extra: diskcache
+Provides-Extra: experiments
+Provides-Extra: lsp
+Provides-Extra: openlineage
+Provides-Extra: pandera
+Provides-Extra: pydantic
+Provides-Extra: pyspark
+Provides-Extra: ray
+Provides-Extra: rich
+Provides-Extra: sdk
+Provides-Extra: slack
+Provides-Extra: tqdm
+Provides-Extra: ui
+Provides-Extra: vaex
+Provides-Extra: visualization
+<div align="center">
+   <h1><img src="https://github.com/apache/hamilton/assets/2328071/feb6abaa-b6d5-4271-a320-0ae4a18d8aa7" width="50"/> Apache Hamilton — portable & expressive <br> data transformation DAGs</h1>
+   <a href='https://hamilton.apache.org/?badge=latest'>
+      <img src='https://readthedocs.org/projects/hamilton/badge/?version=latest' alt='Documentation Status' />
+   </a><a href="https://www.python.org/downloads/" target="_blank">
+      <img src="https://img.shields.io/badge/python-3.8|%203.9|%203.10|%203.11|%203.12-blue.svg" alt="Python supported"/>
+   </a>
+   <a href="https://pypi.org/project/sf-hamilton/" target="_blank">
+      <img src="https://badge.fury.io/py/sf-hamilton.svg" alt="PyPi Version"/>
+   </a>
+   <a href="https://pepy.tech/project/sf-hamilton" target="_blank">
+      <img src="https://pepy.tech/badge/sf-hamilton" alt="Total Downloads"/>
+   </a>
+   <a href="https://pepy.tech/project/sf-hamilton" target="_blank">
+      <img src="https://static.pepy.tech/badge/sf-hamilton/month" alt="Total Monthly Downloads"/>
+   </a>
+   <br/>
+   <a target="_blank" href="https://linkedin.com/showcase/dagster" style="background:none">
+      <img src="https://img.shields.io/badge/DAGWorks-Follow-purple.svg?logo=linkedin" />
+   </a>
+   <a href="https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g" target="_blank">
+      <img src="https://img.shields.io/badge/Apache Hamilton-Join-purple.svg?logo=slack" alt="Apache Hamilton Slack"/>
+   </a>
+   <a href="https://twitter.com/hamilton_os" target="_blank">
+      <img src="https://img.shields.io/badge/HamiltonOS-Follow-purple.svg?logo=X"/>
+   </a>
+   <a href="https://twitter.com/dagworks" target="_blank">
+      <img src="https://img.shields.io/badge/DAGWorks-Follow-purple.svg?logo=X"/>
+   </a>
+</div>
+<br></br>
+
+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).
+
+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!
+
+<div align="center">
+  <img src="./docs/_static/abc_highlight.png" alt="Create a project" width="65%"/>
+</div>
+<div align="center">
+   Functions <code>B()</code> and <code>C()</code> refer to function <code>A</code> via their parameters
+</div>
+<br>
+
+Apache Hamilton brings modularity and structure to any Python application moving data: ETL pipelines, ML workflows, LLM applications, RAG systems, BI dashboards, and the [Apache Hamilton UI](https://hamilton.apache.org/concepts/ui) allows you to automatically visualize, catalog, and monitor execution.
+
+> Apache Hamilton is great for DAGs, but if you need loops or conditional logic to create an LLM agent or a simulation, take a look at our sister library  [Burr](https://github.com/apache/burr) 🤖 .
+
+
+# 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.
+
+```bash
+pip install "sf-hamilton[visualization]"
+```
+
+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)
+
+# Why use Apache Hamilton?
+
+Data teams write code to deliver business value, but few have the resources to standardize practices and provide quality assurance. Moving from proof-of-concept to production and cross-function collaboration (e.g., data science, engineering, ops) remain challenging for teams, big or small. Apache Hamilton is designed to help throughout a project's lifecycle:
+
+- **Separation of concerns**. Apache Hamilton separates the DAG "definition" and "execution" which lets data scientists focus on solving problems and engineers manage production pipelines.
+
+- **Effective collaboration**. The [Apache Hamilton UI provides a shared interface](https://hamilton.apache.org/hamilton-ui/ui/) for teams to inspect results and debug failures throughout the development cycle.
+
+- **Low-friction dev to prod**. Use `@config.when()` to modify your DAG between execution environments instead of error-prone `if/else` feature flags. The notebook extension prevents the pain of migrating code from a notebook to a Python module.
+
+- **Portable transformations**. Your DAG is [independent of infrastructure or orchestration](https://blog.dagworks.io/publish/posts/detail/145543927?referrer=%2Fpublish%2Fposts), meaning you can develop and debug locally and reuse code across contexts (local, Airflow, FastAPI, etc.).
+
+- **Maintainable DAG definition**. Apache Hamilton [automatically builds the DAG from a single line of code whether it has 10 or 1000 nodes](https://hamilton.apache.org/concepts/driver/). It can also assemble multiple Python modules into a pipeline, encouraging modularity.
+
+- **Expressive DAGs**. [Function modifiers](https://hamilton.apache.org/concepts/function-modifiers/) are a unique feature to keep your code [DRY](https://en.wikipedia.org/wiki/Don't_repeat_yourself) and reduce the complexity of maintaining large DAGs. Other frameworks inevitably lead to code redundancy or bloated functions.
+
+- **Built-in coding style**. The Apache Hamilton DAG is [defined using Python functions](https://hamilton.apache.org/concepts/node/), encouraging  modular, easy-to-read, self-documenting, and unit testable code.
+
+- **Data and schema validation**. Decorate functions with `@check_output` to validate output properties, and raise warnings or exceptions. Add the `SchemaValidator()` adapter to automatically inspect dataframe-like objects (pandas, polars, Ibis, etc.) to track and validate their schema.
+
+- **Built for plugins**. Apache Hamilton is designed to play nice with all tools and provides the right abstractions to create custom integrations with your stack. Our lively community will help you build what you need!
+
+
+# Apache Hamilton UI
+
+You can track the execution of your Apache Hamilton DAG in the [Apache Hamilton UI](https://hamilton.apache.org/hamilton-ui/ui/). It automatically populates a data catalog with lineage / tracing and provides execution observability to inspect results and debug errors. You can run it as a [local server](https://hamilton.apache.org/hamilton-ui/ui/#local-mode) or a [self-hosted application using Docker](https://hamilton.apache.org/hamilton-ui/ui/#docker-deployed-mode).
+
+<p align="center">
+  <img src="./docs/_static/hamilton_1.jpeg" alt="Description1" width="30%" style="margin-right: 20px;"/>
+  <img src="./docs/_static/hamilton_2.jpeg" alt="Description2" width="30%" style="margin-right: 20px;"/>
+  <img src="./docs/_static/hamilton_3.jpeg" alt="Description3" width="30%"/>
+</p>
+<p align="center">
+  <em>DAG catalog, automatic dataset profiling, and execution tracking</em>
+</p>
+
+
+## Get started with the Apache Hamilton UI
+
+1. To use the Apache Hamilton UI, install the dependencies (see `Installation` section) and start the server with
+
+   ```bash
+   hamilton ui
+   ```
+
+2. On the first connection, create a `username` and a new project (the `project_id` should be `1`).
+
+<div align="center">
+  <img src="./docs/_static/new_project.png" alt="Create a project" width="70%"/>
+</div>
+<br>
+
+3. Track your Apache Hamilton DAG by creating a `HamiltonTracker` object with your `username` and `project_id` and adding it to your `Builder`. Now, your DAG will appear in the UI's catalog and all executions will be tracked!
+
+   ```python
+   from hamilton import driver
+   from hamilton_sdk.adapters import HamiltonTracker
+   import my_dag
+
+   # use your `username` and `project_id`
+   tracker = HamiltonTracker(
+      username="my_username",
+      project_id=1,
+      dag_name="hello_world",
+   )
+
+   # adding the tracker to the `Builder` will add the DAG to the catalog
+   dr = (
+      driver.Builder()
+      .with_modules(my_dag)
+      .with_adapters(tracker)  # add your tracker here
+      .build()
+   )
+
+   # executing the `Driver` will track results
+   dr.execute(["C"])
+   ```
+
+# Documentation & learning resources
+
+* 📚 See the [official documentation](https://hamilton.apache.org/) to learn about the core concepts of Apache Hamilton.
+
+* 👨‍🏫 Consult the [examples on GitHub](https://github.com/apache/hamilton/tree/main/examples) to learn about specific features or integrations with other frameworks.
+
+* 📰 The [DAGWorks blog](https://blog.dagworks.io/) includes guides about how to build a data platform and narrative tutorials.
+
+* 📺 Find video tutorials on the [DAGWorks YouTube channel](https://www.youtube.com/@DAGWorks-Inc)
+
+* 📣 Reach out via the [Apache Hamilton Slack community](https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g) for help and troubleshooting
+
+
+# How does Apache Hamilton compare to X?
+
+Apache Hamilton is not an orchestrator ([you might not need one](https://blog.dagworks.io/p/lean-data-automation-a-principal)), nor a feature store ([but you can use it to build one!](https://blog.dagworks.io/p/featurization-integrating-hamilton)). Its purpose is to help you structure and manage data transformations. If you know dbt, Apache Hamilton does for Python what dbt does for SQL.
+
+Another way to frame it is to think about the different layers of a data stack. Apache Hamilton is at the **asset layer**. It helps you organize data transformations code (the **expression layer**), manage changes, and validate & test data.
+
+<div align="center" style="width: 100%">
+   <table>
+      <colgroup>
+         <col style="width: 20%">
+         <col style="width: 40%">
+         <col style="width: 40%">
+      </colgroup>
+      <thead>
+         <tr>
+               <th>Layer</th>
+               <th>Purpose</th>
+               <th>Example Tools</th>
+         </tr>
+      </thead>
+      <tbody>
+         <tr>
+               <td>Orchestration</td>
+               <td>Operational system for the creation of assets</td>
+               <td>Airflow, Metaflow, Prefect, Dagster</td>
+         </tr>
+         <tr>
+               <td>Asset</td>
+               <td>Organize expressions into meaningful units <br> (e.g., dataset, ML model, table)</td>
+               <td><b>Apache Hamilton</b>, dbt, dlt, SQLMesh, <a href="https://github.com/apache/burr">Burr</a></td>
+         </tr>
+         <tr>
+               <td>Expression</td>
+               <td>Language to write data transformations</td>
+               <td>pandas, SQL, polars, Ibis, LangChain</td>
+         </tr>
+         <tr>
+               <td>Execution</td>
+               <td>Perform data transformations</td>
+               <td>Spark, Snowflake, DuckDB, RAPIDS</td>
+         </tr>
+         <tr>
+               <td>Data</td>
+               <td>Physical representation of data, inputs and outputs</td>
+               <td>S3, Postgres, file system, Snowflake</td>
+         </tr>
+      </tbody>
+   </table>
+</div>
+
+See our page on [Why use Apache Hamilton?](https://hamilton.apache.org/get-started/why-hamilton/) and framework [code comparisons](https://hamilton.apache.org/code-comparisons/) for more information.
+
+# 📑 License
+
+Apache Hamilton is released under the Apache 2.0 License. See [LICENSE](https://github.com/apache/hamilton/blob/main/LICENSE.md) for details.
+
+
+# 🌎 Community
+## 👨‍💻 Contributing
+We're very supportive of changes by new contributors, big or small! Make sure to discuss potential changes by creating an issue or commenting on an existing one before opening a pull request. Good first contributions include creating an example or an integration with your favorite Python library!
+
+ To contribute, checkout our [contributing guidelines](https://github.com/apache/hamilton/blob/main/CONTRIBUTING.md), our [developer setup guide](https://github.com/apache/hamilton/blob/main/developer_setup.md), and our [Code of Conduct](https://github.com/apache/hamilton/blob/main/CODE_OF_CONDUCT.md).
+
+
+## 😎 Used by
+Apache Hamilton was started at Stitch Fix before the original creators founded DAGWorks Inc! The library is battle-tested and has been supporting production use cases since 2019.
+
+>Read more about the [origin story](https://multithreaded.stitchfix.com/blog/2021/10/14/functions-dags-hamilton/).
+
+
+* [Stitch Fix](https://www.stitchfix.com/) — Time series forecasting
+* [UK Government Digital Services](https://github.com/alphagov/govuk-feedback-analysis) — National feedback pipeline (processing & analysis)
+* [IBM](https://www.ibm.com/) — Internal search and ML pipelines
+* [Opendoor](https://www.opendoor.com/) — Manage PySpark pipelines
+* [Lexis Nexis](https://www.lexisnexis.com/en-us/home.page) — Feature processing and lineage
+* [Adobe](https://www.adobe.com/) — Prompt engineering research
+* [WrenAI](https://github.com/Canner/WrenAI) — async text-to-SQL workflows
+* [British Cycling](https://www.britishcycling.org.uk/) — Telemetry analysis
+* [Oak Ridge & PNNL](https://pnnl.gov/) — Naturf project
+* [ORNL](https://www.ornl.gov/)
+* [Federal Reserve Board](https://www.federalreserve.gov/)
+* [Joby Aviation](https://www.jobyaviation.com/) — Flight data processing
+* [Two](https://www.two.inc/)
+* [Transfix](https://transfix.io/) — Online featurization and prediction
+* [Railofy](https://www.railofy.com) — Orchestrate pandas code
+* [Habitat Energy](https://www.habitat.energy/) — Time-series feature engineering
+* [KI-Insurance](https://www.ki-insurance.com/) — Feature engineering
+* [Ascena Retail](https://www.ascena.com/) — Feature engineering
+* [NaroHQ](https://www.narohq.com/)
+* [EquipmentShare](https://www.equipmentshare.com/)
+* [Everstream.ai](https://www.everstream.ai/)
+* [Flectere](https://flectere.net/)
+* [F33.ai](https://f33.ai/)
+* [Kora Money](https://www.koramoney.com)
+* [Capitec Bank](https://www.capitecbank.co.za/)
+* [Best Egg](https://bestegg.com/)
+* [RTV Euro AGD](https://www.euro.com.pl/)
+* [Wealth.com](https://www.wealth.com/)
+* [wren.ai](https://wren.ai/)
+
+## 🤝 Code Contributors
+[![Contributors](https://contrib.rocks/image?repo=dagworks-inc/hamilton)](https://github.com/apache/hamilton/graphs/contributors)
+
+
+## 🙌 Special Mentions & 🦟 Bug Hunters
+
+Thanks to our awesome community and their active involvement in the Apache Hamilton library.
+
+[Nils Olsson](https://github.com/nilsso), [Michał Siedlaczek](https://github.com/elshize), [Alaa Abedrabbo](https://github.com/AAbedrabbo), [Shreya Datar](https://github.com/datarshreya), [Baldo Faieta](https://github.com/baldofaieta), [Anwar Brini](https://github.com/AnwarBrini), [Gourav Kumar](https://github.com/gms101), [Amos Aikman](https://github.com/amosaikman), [Ankush Kundaliya](https://github.com/akundaliya), [David Weselowski](https://github.com/j7zAhU), [Peter Robinson](https://github.com/Peter4137), [Seth Stokes](https://github.com/sT0v), [Louis Maddox](https://github.com/lmmx), [Stephen Bias](https://github.com/s-ducks), [Anup Joseph](https://github.com/AnupJoseph), [Jan Hurst](https://github.com/janhurst), [Flavia Santos](https://github.com/flaviassantos), [Nicolas Huray](https://github.com/nhuray), [Manabu Niseki](https://github.com/ninoseki), [Kyle Pounder](https://github.com/kpounder), [Alex Bustos](https://github.com/bustosalex1), [Andy Day](https://github.com/adayNU), [Alexander Cai](https://github.com/adzcai), [Nils Müller-Wendt](https://github.com/ChronoJon), [Paul Larsen](https://github.com/munichpavel), [
+Kemal Eren](https://github.com/kemaleren), [Jernej Frank](https://github.com/jernejfrank), [Noah Ridge](https://github.com/noahridge)
+
+# 🎓 Citations
+We'd appreciate citing Apache Hamilton by referencing one of the following:
+
+```bibtex
+@inproceedings{DBLP:conf/vldb/KrawczykI22,
+  title     = {Hamilton: a modular open source declarative paradigm for high level
+               modeling of dataflows},
+  author    = {Stefan Krawczyk and Elijah ben Izzy},
+  editor    = {Satyanarayana R. Valluri and Mohamed Za{\"{\i}}t},
+  booktitle = {1st International Workshop on Composable Data Management Systems,
+               CDMS@VLDB 2022, Sydney, Australia, September 9, 2022},
+  year      = {2022},
+  url       = {https://cdmsworkshop.github.io/2022/Proceedings/ShortPapers/Paper6\_StefanKrawczyk.pdf},
+  timestamp = {Wed, 19 Oct 2022 16:20:48 +0200},
+  biburl    = {https://dblp.org/rec/conf/vldb/KrawczykI22.bib},
+  bibsource = {dblp computer science bibliography, https://dblp.org}
+}
+```
+```bibtex
+@inproceedings{CEURWS:conf/vldb/KrawczykIQ22,
+  title     = {Hamilton: enabling software engineering best practices for data transformations via generalized dataflow graphs},
+  author    = {Stefan Krawczyk and Elijah ben Izzy and Danielle Quinn},
+  editor    = {Cinzia Cappiello and Sandra Geisler and Maria-Esther Vidal},
+  booktitle = {1st International Workshop on Data Ecosystems co-located with 48th International Conference on Very Large Databases (VLDB 2022)},
+  pages     = {41--50},
+  url       = {https://ceur-ws.org/Vol-3306/paper5.pdf},
+  year      = {2022}
+}
+```
+
+# 📚 Libraries built on / for Apache Hamilton
+* [Hypster](https://github.com/gilad-rubin/hypster) - hyperparameter management
+* [DSP Decision Engine](https://github.com/capitec/dsp-decision-engine) - decision trees
+* [NaturF](https://github.com/IMMM-SFA/naturf/) - library for data transformation for weather forecasting
+* [WrenAI](https://github.com/Canner/WrenAI) - RAG
+* [FlowerPower](https://github.com/legout/flowerpower/) - Scheduler for Apache Hamilton
+