Skip to main content

AWS IoT SDK based on the AWS Common Runtime

Project description

AWS IoT Device SDK v2 for Python

Version

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.6+

Install from PyPI

python3 -m pip install awsiotsdk

Install from source

git clone https://github.com/aws/aws-iot-device-sdk-python-v2.git
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, be sure the following are installed and try again:

  • CMake 3.1+
  • Python headers and libs
sudo apt-get update
sudo apt-get install cmake
sudo apt-get install python3-dev

Mac-Only TLS Behavior

Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.3.2, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:

static: certificate has an existing certificate-key pair that was previously imported into the Keychain.  Using key from Keychain instead of the one provided.

Samples

Samples README

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:

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.

License

This library is licensed under the Apache 2.0 License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

awsiotsdk-1.5.18.tar.gz (48.5 kB view details)

Uploaded Source

Built Distribution

awsiotsdk-1.5.18-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file awsiotsdk-1.5.18.tar.gz.

File metadata

  • Download URL: awsiotsdk-1.5.18.tar.gz
  • Upload date:
  • Size: 48.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.9

File hashes

Hashes for awsiotsdk-1.5.18.tar.gz
Algorithm Hash digest
SHA256 06ff8dde09183b757d1edf4583e3e72c94c987223ad83ee983036256de9fadc3
MD5 9785bf105a02db08c7796a24dc7e52da
BLAKE2b-256 dae85398782efc7f9faffde2aac238d675fb8cb4be83343c83fd81bd6d6996d2

See more details on using hashes here.

File details

Details for the file awsiotsdk-1.5.18-py3-none-any.whl.

File metadata

  • Download URL: awsiotsdk-1.5.18-py3-none-any.whl
  • Upload date:
  • Size: 45.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.6.9

File hashes

Hashes for awsiotsdk-1.5.18-py3-none-any.whl
Algorithm Hash digest
SHA256 c34dd19e70be9e81d1f4447776cf67fafdada375da6b377295b8a98582b488db
MD5 a651d792e65b6e4993e1d1d061a13244
BLAKE2b-256 a0ab22ca72d7e3337ee07681664fcc1525b27ae3b09f25377ffc0e71ed92c40a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page