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.

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

examples/dlt ELT to load Slack messages and use OpenAI for summaries #803

Merged
merged 4 commits into from
Apr 4, 2024

Conversation

zilto
Copy link
Collaborator

@zilto zilto commented Apr 3, 2024

[WIP]
Goal is to showcase "dlt + Hamilton (+ Ibis)" for a lightweight and portable Python toolkit.

Changes

  • added examples/dlt

How I tested this

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)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have notebooks to show things too?

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also perhaps start including something at the top of a file to help describe whether this is hamilton code or supporting code or something else. Would make it a little quicker to grok.

@zilto
Copy link
Collaborator Author

zilto commented Apr 4, 2024

we should also perhaps start including something at the top of a file to help describe whether this is hamilton code or supporting code or something else. Would make it a little quicker to grok.

The README #Content is my best attempt

  1. Low constraint approach: use module docstrings
  2. More robust approach: have a tool.hamilton entry in pyproject.toml specifying the dataflows and modules included in the project.

Approach 2 has the benefit of being centralized which is great for readability but also CI, testing, etc.

@zilto zilto marked this pull request as ready for review April 4, 2024 18:39
Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (other than would like a notebook for the example ;))

@zilto zilto merged commit 917a6a5 into main Apr 4, 2024
23 checks passed
@zilto zilto deleted the examples/dlt branch April 4, 2024 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants