Skip to content
This repository has been archived by the owner on Jul 3, 2023. It is now read-only.

Adds more links to the Discord channel #74

Merged
merged 1 commit into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ For the backstory on how Hamilton came about, see our [blog post!](https://multi

# Getting Started
Here's a quick getting started guide to get you up and running in less than 15 minutes.
If you need help join our [discord](https://discord.gg/wCqxqBqn73) community to chat/ask Qs/etc.

## Installation
Requirements:
Expand Down Expand Up @@ -124,6 +125,9 @@ You should see the following image if you ran `dr.visualize_execution(output_col

Congratulations - you just created your Hamilton dataflow that created a dataframe!

# Discord Community
We have a small but active community on [discord](https://discord.gg/wCqxqBqn73). Come join us!

# License
Hamilton is released under the [BSD 3-Clause Clear License](LICENSE). If you need to get in touch about something,
contact us at algorithms-opensource (at) stitchfix.com.
Expand Down
3 changes: 3 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Here you'll find some very simple hello world type examples.

If you have questions, or need help with these examples,
join us on [discord](https://discord.gg/wCqxqBqn73), and we'll try to help!

## Show casing scaling Pandas
The `hello_world` folder shows a simple example of how to create a Hamilton DAG and run it.

Expand Down
19 changes: 19 additions & 0 deletions examples/hello_world/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Classic Hamilton Hello World

In this example we show you how to create a simple hello world dataflow that
creates a dataframe as a result. It performs a series of transforms on the
input to create columns that appear in the output.

File organization:

* `my_functions.py` houses the logic that we want to compute. Note how the functions are named, and what input
parameters they require. That is how we create a DAG modeling the dataflow we want to happen.
* `my_script.py` houses how to get Hamilton to create the DAG and exercise it with some inputs.

To run things:
```bash
> python my_script.py
```

If you have questions, or need help with this example,
join us on [discord](https://discord.gg/wCqxqBqn73), and we'll try to help!