diff --git a/README.md b/README.md index df396020..ce14d006 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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. diff --git a/examples/README.md b/examples/README.md index cfbf131c..58789751 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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. diff --git a/examples/hello_world/README.md b/examples/hello_world/README.md new file mode 100644 index 00000000..6fd5b955 --- /dev/null +++ b/examples/hello_world/README.md @@ -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!