From ed12f1afe2953d3d0d6e0941975e098428634cfa Mon Sep 17 00:00:00 2001 From: Lyndsy Simon Date: Sun, 20 Oct 2019 21:51:00 -0500 Subject: [PATCH] Add README --- python/README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 python/README.md diff --git a/python/README.md b/python/README.md new file mode 100644 index 0000000..c3754ae --- /dev/null +++ b/python/README.md @@ -0,0 +1,25 @@ +# sdk:python + +```python +from pipedream import sdk as pd + +pd.send_event(API_KEY, {'hello': 'world'}) + +# with exports +pd.send_event( + API_KEY, + {'hello': 'world'}, + exports={ + 'event': {'hello': 'world!'}, + 'other_export': 'howdy', + } +) +``` + +If you do not provide an `event` export it will be set to the `raw_event` +(first argument). `event` and `raw_event` MUST be a dict or the SDK request +will be invalid. + +## Development + +TODO