Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Contrib/translate to hamilton #583

Merged
merged 2 commits into from Dec 14, 2023
Merged

Contrib/translate to hamilton #583

merged 2 commits into from Dec 14, 2023

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Dec 11, 2023

Adds dataflow for people to use to translate their code into Hamilton code.

For new dataflows:

Do you have the following?

  • Added a directory mapping to my github user name in the contrib/hamilton/contrib/user directory.
    • If my author names contains hyphens I have replaced them with underscores.
    • If my author name starts with a number, I have prefixed it with an underscore.
    • If your author name is a python reserved keyword. Reach out to the maintainers for help.
    • Added an author.md file under my username directory and is filled out.
    • Added an init.py file under my username directory.
  • Added a new folder for my dataflow under my username directory.
    • Added a README.md file under my dataflow directory that follows the standard headings and is filled out.
    • Added a init.py file under my dataflow directory that contains the Hamilton code.
    • Added a requirements.txt under my dataflow directory that contains the required packages outside of Hamilton.
    • Added tags.json under my dataflow directory to curate my dataflow.
    • Added valid_configs.jsonl under my dataflow directory to specify the valid configurations.
    • Added a dag.png that shows one possible configuration of my dataflow.
  • I hearby acknowledge that to the best of my ability, that the code I have contributed contains correct attribution
    and notices as appropriate.

For existing dataflows -- what has changed?

How I tested this

  • Ran it locally
  • added one test

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Dataflow documentation has been updated if adding/changing functionality.

@sweep-ai Sweep AI
Copy link
Contributor

sweep-ai bot commented Dec 11, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@skrawcz
Adds prompt and flow to convert code to Hamilton
ec75093 
This prompt and flow will likely change over time, but this
is a first stab at sharing something that others can use to
translate code with into Hamilton.
@skrawcz skrawcz force-pushed the contrib/translate_to_hamilton branch from c667db1 to ec75093 Compare December 11, 2023 05:21
@skrawcz skrawcz merged commit 51685b4 into main Dec 14, 2023
24 checks passed
@skrawcz skrawcz deleted the contrib/translate_to_hamilton branch December 14, 2023 05:27
@elijahbenizzy elijahbenizzy mentioned this pull request Dec 15, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@skrawcz