AWS IoT Device SDK v2 for Python
This document provides information about the AWS IoT Device SDK v2 for Python.
If you have any issues or feature requests, please file an issue or pull request.
API documentation: https://aws.github.io/aws-iot-device-sdk-python-v2/
This SDK is built on the AWS Common Runtime, a collection of libraries
(aws-c-common,
aws-c-io,
aws-c-mqtt,
aws-c-compression,
aws-c-http,
aws-c-cal,
aws-c-auth,
s2n ...) written in C to be
cross-platform, high-performance, secure, and reliable. The libraries are bound
to Python by the awscrt package (PyPI) (Github).
Jump To:
Installation
Minimum Requirements
- Python 3.7+
Install from PyPI
MacOS and Linux:
python3 -m pip install awsiotsdk
Windows:
python -m pip install awsiotsdk
Install from source
# Create a workspace directory to hold all the SDK files
mkdir sdk-workspace
cd sdk-workspace
# Clone the repository
git clone https://github.com/aws/aws-iot-device-sdk-python-v2.git
# Install using Pip (use 'python' instead of 'python3' on Windows)
python3 -m pip install ./aws-iot-device-sdk-python-v2
Installation Issues
awsiotsdk depends on awscrt, which makes use of C extensions. Precompiled wheels are downloaded when installing on major platforms (Mac, Windows, Linux, Raspberry Pi OS). If wheels are unavailable for your platform, your machine must compile some C libraries.
If you encounter issues, see Installation Issues and try again.
Samples
Getting Help
The best way to interact with our team is through GitHub. You can open an issue and choose from one of our templates for guidance, bug reports, or feature requests. You may also find help on community resources such as StackOverFlow with the tag #aws-iot or If you have a support plan with AWS Support, you can also create a new support case.
Please make sure to check out our resources too before opening an issue:
- Our FAQ
- API documentation
- Our Developer Guide (source)
- Check for similar Issues
- AWS IoT Core Documentation
- Dev Blog
- Integration with AWS IoT Services such as Device Shadow and Jobs is provided by code that been generated from a model of the service.
Giving Feedback and Contributions
We need your help in making this SDK great. Please participate in the community and contribute to this effort by submitting issues, participating in discussion forums and submitting pull requests through the following channels.
- Contributions Guidelines
- Articulate your feature request or upvote existing ones on our Issues page.
- Create discussion questions here
- Find a bug open an issue
License
This library is licensed under the Apache 2.0 License.
Latest released version: v1.15.1