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. This SDK is built on the AWS Common Runtime

Jump To:

Installation

Minimum Requirements

  • Python 3.7+

Step-by-step instructions

Install from PyPI

MacOS and Linux:

python3 -m pip install awsiotsdk

Windows:

python -m pip install awsiotsdk

Install from source

# 1. Create a workspace directory to hold all the SDK files
mkdir sdk-workspace
cd sdk-workspace

# 2. Clone the repository. You could select the version of the SDK you desire to use.
git clone -b <SDK_VERSION> https://github.com/aws/aws-iot-device-sdk-python-v2.git

# 3. (Optional) Setup the version number of your local build. The default version 
#    for awsiotsdk is set to "1.0.0-dev", you can set the version number of the
#    local build in "aws-iot-device-sdk-python-v2/awsiot/__init__.py"
sed -i "s/__version__ = '1.0.0-dev'/__version__ = '<SDK_VERSION>'/" \
  aws-iot-device-sdk-python-v2/awsiot/__init__.py

# 4. Install using Pip (use 'python' instead of 'python3' on Windows)
python3 -m pip install ./aws-iot-device-sdk-python-v2

Samples

Samples README

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.7.3, 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.

Getting Help

The best way to interact with our team is through GitHub. You can open a discussion for guidance questions or an issue for 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:

License

This library is licensed under the Apache 2.0 License.

Latest released version: v1.24.0

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.24.0.tar.gz (89.4 kB view details)

Uploaded Source

Built Distribution

awsiotsdk-1.24.0-py3-none-any.whl (80.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: awsiotsdk-1.24.0.tar.gz
  • Upload date:
  • Size: 89.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for awsiotsdk-1.24.0.tar.gz
Algorithm Hash digest
SHA256 e4f91d2a1efd82dea7586c9f6d3aebc2783aaa58b979a4229f5939f22a31c741
MD5 27ec33e3dcd513db079381a8560e6957
BLAKE2b-256 ef531c156564e68a7079333f077107697f30f8cbcc19113e9d6a03a98fc05d36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: awsiotsdk-1.24.0-py3-none-any.whl
  • Upload date:
  • Size: 80.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for awsiotsdk-1.24.0-py3-none-any.whl
Algorithm Hash digest
SHA256 254f4d7801ce481d329fe0ab755580c1d933fbe3a48dcdd2ada6ae1e7752ef3d
MD5 108d8b8becb5da5c373ca9de19b3a034
BLAKE2b-256 eac0e5ddcf2b107482abe329c99117f990e2fa88dd8edc3d740044254e1cad3b

See more details on using hashes here.

Supported by

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