apache-hamilton-contrib 0.1.0.dev0__tar.gz

apache_hamilton_contrib-0.1.0.dev0/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_contrib-0.1.0.dev0/LICENSE

@@ -0,0 +1,228 @@
+                                 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.

apache_hamilton_contrib-0.1.0.dev0/NOTICE

@@ -0,0 +1,35 @@
+Apache Hamilton (Incubating)
+Copyright 2025-2026 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+================================================================================
+
+This product includes code adapted from the OpenAI Cookbook
+(https://github.com/openai/openai-cookbook), which is licensed under the MIT License.
+Specifically, the hamilton.contrib.user.skrawcz.customize_embeddings module is based on:
+https://github.com/openai/openai-cookbook/blob/6d89e11fed344237f07910a98ba98303ece7dd18/examples/Customizing_embeddings.ipynb
+
+  MIT License
+  Copyright (c) 2025 OpenAI
+
+================================================================================
+
+This product includes code adapted from NumPy Tutorials
+(https://github.com/numpy/numpy-tutorials), which is licensed under the BSD 3-Clause License.
+Specifically, the hamilton.contrib.user.skrawcz.air_quality_analysis module is based on:
+https://github.com/numpy/numpy-tutorials/blob/main/content/tutorial-air-quality-analysis.md
+
+  BSD 3-Clause License
+  Copyright (c) 2005-2025, NumPy Developers
+
+================================================================================
+
+This product references code patterns from Optuna Examples
+(https://github.com/optuna/optuna-examples), which is licensed under the MIT License.
+Specifically, the hamilton.contrib.user.zilto.xgboost_optuna module references:
+https://github.com/optuna/optuna-examples/blob/main/xgboost/xgboost_integration.py
+
+  MIT License
+  Copyright (c) 2018 Preferred Networks, Inc.

apache_hamilton_contrib-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.4
+Name: apache-hamilton-contrib
+Version: 0.1.0.dev0
+Summary: Apache Hamilton's user contributed shared dataflow library.
+Keywords: hamilton,collaborative,shared,dataflow,library,contrib
+Author-email: Stefan Krawczyk <stefank@cs.stanford.edu>, Elijah ben Izzy <elijah@dagworks.io>
+Requires-Python: >=3.10, <4
+Description-Content-Type: text/markdown
+License-Expression: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+License-File: DISCLAIMER
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: apache-hamilton==1.90.0.dev0
+Requires-Dist: click>8.0.0 ; extra == "contribute"
+Requires-Dist: gitpython ; extra == "contribute"
+Requires-Dist: apache-hamilton[visualization] ; extra == "visualization"
+Project-URL: documentation, https://hamilton.apache.org/
+Project-URL: homepage, https://www.tryhamilton.dev/
+Project-URL: issues, https://github.com/apache/hamilton/issues
+Project-URL: source, https://github.com/apache/hamilton/contrib
+Provides-Extra: contribute
+Provides-Extra: visualization
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you 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.
+-->
+
+## Off-the-shelf Apache Hamilton Dataflows
+
+> **Disclaimer**
+>
+> Apache Hamilton 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.
+
+Here you'll find documentation about the sf-hamilton-contrib package that curates a collection of Apache Hamilton Dataflows that are
+ready to be used in your own projects. They are user-contributed and maintained, with
+the goal of making it easier for you to get started with Apache Hamilton.
+
+We expect this collection to grow over time, so check back often! As dataflows become mature we
+will move them into the official sub-package of the respository and become maintained by the
+Apache Hamilton team.
+
+### Usage
+There are two ways to get access to dataflows in this package. For either approach,
+the assumption is that you have the requisite python dependencies installed on your system.
+You'll get import errors if you don't. Don't know what you need, we have convenience functions to help!
+
+#### Static installation
+This approach relies on you installing the package on your system. This is the recommended path for
+production purposes as you can version-lock your dependencies.
+
+To install the package, run:
+
+```bash
+pip install sf-hamilton-contrib --upgrade
+```
+
+Once installed, you can import the dataflows as follows.
+
+Things you need to know:
+1. Whether it's a user or official DAGWorks supported dataflow. If user, what the name of the user is.
+2. The name of the dataflow.
+```python
+from hamilton import driver
+# from hamilton.contrib.dagworks import NAME_OF_DATAFLOW
+from hamilton.contrib.user.NAME_OF_USER import NAME_OF_DATAFLOW
+
+dr = (
+    driver.Builder()
+    .with_config({})  # replace with configuration as appropriate
+    .with_modules(NAME_OF_DATAFLOW)
+    .build()
+)
+# execute the dataflow, specifying what you want back. Will return a dictionary.
+result = dr.execute(
+    [NAME_OF_DATAFLOW.FUNCTION_NAME, ...],  # this specifies what you want back
+    inputs={...}  # pass in inputs as appropriate
+)
+```
+To find an example [go to the hub](https://hub.dagworks.io/docs/).
+
+#### Dynamic installation
+Here we dynamically download the dataflow from the internet and execute it. This is useful for quickly
+iterating in a notebook and pulling in just the dataflow you need.
+
+```python
+from hamilton import dataflows, driver
+
+# downloads into ~/.hamilton/dataflows and loads the module -- WARNING: ensure you know what code you're importing!
+# NAME_OF_DATAFLOW = dataflows.import_module("NAME_OF_DATAFLOW") # if using official DAGWorks dataflow
+NAME_OF_DATAFLOW = dataflows.import_module("NAME_OF_DATAFLOW", "NAME_OF_USER")
+dr = (
+  driver.Builder()
+  .with_config({})  # replace with configuration as appropriate
+  .with_modules(NAME_OF_DATAFLOW)
+  .build()
+)
+# execute the dataflow, specifying what you want back. Will return a dictionary.
+result = dr.execute(
+  [NAME_OF_DATAFLOW.FUNCTION_NAME, ...],  # this specifies what you want back
+  inputs={...}  # pass in inputs as appropriate
+)
+```
+To find an example [go to the hub](https://hub.dagworks.io/docs/).
+
+#### Modification
+Getting started is one thing, but then modifying to your needs is another. So we have a prescribed
+flow to enable you to take a dataflow, and copy the code to a place of your choosing. This allows
+you to easily modify the dataflow as you see fit.
+
+Run this in a notebook or python script to copy the dataflow to a directory of your choosing.
+```python
+from hamilton import dataflows
+
+# dynamically pull and then copy
+NAME_OF_DATAFLOW = dataflows.import_module("NAME_OF_DATAFLOW", "NAME_OF_USER")
+dataflows.copy(NAME_OF_DATAFLOW, destination_path="PATH_TO_DIRECTORY")
+# copy from the installed library
+from hamilton.contrib.user.NAME_OF_USER import NAME_OF_DATAFLOW
+dataflows.copy(NAME_OF_DATAFLOW, destination_path="PATH_TO_DIRECTORY")
+```
+You can then modify/import the code as you see fit. See [copy()](https://hamilton.apache.org/reference/dataflows/copy/)
+for more details.
+
+
+### How to contribute
+
+If you have a dataflow that you would like to share with the community, please submit a pull request
+to this repository. We will review your dataflow and if it meets our standards we will add it to the
+package. To submit a pull request please use [this template](https://github.com/apache/hamilton/blob/main/.github/PULL_REQUEST_TEMPLATE/HAMILTON_CONTRIB_PR_TEMPLATE.md)
+. To access it, create a new Pull Request, then hit the `preview` tab, and click the link to append `template=HAMILTON_CONTRIB_PR_TEMPLATE.md` to the URL.
+
+
+#### Dataflow standards
+We want to ensure that the dataflows in this package are of high quality and are easy to use. To that end,
+we have a set of standards that we expect all dataflows to meet. If you have any questions, please reach out.
+
+Standards:
+- The dataflow must be a valid Python module.
+- It must not do anything malicious.
+- It must be well documented.
+- It must work.
+- It must follow our standard structure as outlined below.
+
+#### Getting started with development
+
+To get started with development, you'll want to first fork the hamilton repository from the github UI.
+
+Then, clone it locally and install the package in editable mode, ensuring you install any dependencies required for the initilization script
+```bash
+cd hamilton # Your fork
+pip install -e "./contrib[contribute]" # Note that this package lives under the `contrib` folder
+```
+
+Next, you need to initialize your dataflow. This will create the necessary files and directories for you to get started.
+```bash
+init-dataflow -u <your_github_username> -n <name_of_dataflow>
+```
+
+This will do the following:
+
+1. Create a package under `contrib/hamilton/contrib/user/<your_github_username>` with the appropriate files to describe you
+   -  `author.md` -- this will describe you with links out to github/socials
+   - `__init__.py` -- this will be an empty file that allows you to import your dataflow
+2. Create a package under `contrib/hamilton/contrib/user/<your_github_username>/<name_of_dataflow>` with the appropriate files to describe your dataflow:
+   - `README.md` to describe the dataflow with the standard headings
+   - `__init__.py` to contain the Apache Hamilton code
+   - `requirements.txt` to contain the required packages outside of Apache Hamilton
+   - `tags.json` to curate your dataflow
+   - `valid_configs.jsonl` to specify the valid configurations for it to be run
+   - `dag.png` to show one possible configuration of your dataflow
+3. Add all the above files to git!
+
+These are all required. You do not have to use the initialization script -- you can always copy the files over directly. That said, it is idempotent (it will fill out any missing files),
+and will ensure that you have the correct structure.
+
+#### Developing your dataflow
+
+To get started, you'll want to do the following:
+
+- [ ] Fill out your `__init__.py` with the appropriate code -- see [this issue](https://github.com/apache/hamilton/issues/559) if you want some inspiration for where to get started
+- [ ] Fill out the sections of your `README.md` with the appropriate documentation -- follow one of the approved dataflows
+- [ ] Fill out your `tags.json` with the appropriate tags -- follow one of the approved dataflows
+- [ ] Fill out your `valid_configs.jsonl` with the appropriate configurations -- this is not necessary if you have no configurations that can change the shape of your DAG
+- [ ] Generate a visual representation of your DAG -- you can use the following `if __name__ == '__main__'` block to do so:
+```python
+import __init__ as my_module
+
+from hamilton import base, driver
+
+dr = driver.Driver(
+    {},
+    my_module,
+    adapter=base.DefaultAdapter(),
+)
+# create the DAG image
+dr.display_all_functions("dag", {"format": "png", "view": False})
+```
+- [ ] Push a branch back to your fork
+- [ ] Open up a pull request to the main Apache Hamilton repo!
+  - [ ] Commit the files we just added
+  - [ ] Create a PR
+  - [ ] Tag one of the maintainers [elijahbenizzy](https://github.com/elijahbenizzy), [skrawcz](https://github.com/skrawcz), or [zilto](https://github.com/zilto) for a review
+  - [ ] Ping us on [slack](https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g) if you don't hear back within a few days
+
+#### Username Management
+
+As usernames map to packages, we need to ensure that they are valid. To that end, we have a few rules:
+  - [ ] If your username contains hyphens, replace them with underscores.
+  - [ ] If your username starts with a number, prefix it with an underscore.
+  - [ ] If your author name is a python reserved keyword. Reach out to the maintainers for help.
+
+If the above apply, run the `init-dataflow` command with `-s` to specify a sanitized username.
+
+## Got questions?
+Join our [slack](https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g) community to chat/ask Qs/etc.
+