timmattison / aws-greengrass-stream-manager-sdk-python Goto Github PK

The AWS Greengrass Stream Manager SDK for Python enables Python developers to manage data streams using Stream Manager on AWS IoT Greengrass core.

This document provides instructions for preparing your Python code to manage Streams in Stream Manager using the Python SDK.

Follow the guide here to work with Streams using the Stream Manager Client from the Stream Manager SDK.

Stream Manager SDK provided by this repo is compatible with Stream Manager running on Greengrass Core 1.11 and above.

This SDK has additional requirements. Specifically, Stream Manager SDK requires Python version 3.6 or above. It also has package requirements listed in the requirements.txt file. Please install these requirements.

To install the requirements you can use pip such as :code:pip install --user -r requirements.txt. This will install the requirements to your Python path on the device. However if you are deploying the code to a device, you can bundle the requirements with your code. With the pip command above, the dependencies will be installed to the user site-packages directory. To find its location, use :code:python -m site --user-site. You can then simply copy the entire user site package directory contents into the final artifact before deploying which will ensure that the Stream Manager dependencies are present.

One way to install both stream-manager and its dependencies (i.e. cbor) is to run the following command:

pip install git+https://github.com/aws-greengrass/aws-greengrass-stream-manager-sdk-python.git

• Ask on a Greengrass forum

Apache 2.0