# AWS IoT Device SDK v2 for Python
[](https://pypi.org/project/awsiotsdk/)
This document provides information about the AWS IoT Device SDK v2 for Python. This SDK is built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)
*__Jump To:__*
* [Installation](#installation)
* [Samples](samples)
* [Mac-Only TLS Behavior](#mac-only-tls-behavior)
* [Getting Help](#getting-help)
* [FAQ](./documents/FAQ.md)
* [API Docs](https://aws.github.io/aws-iot-device-sdk-python-v2/)
* [MQTT5 User Guide](./documents/MQTT5_Userguide.md)
* [Migration Guide from the AWS IoT SDK for Python v1](./documents/MIGRATION_GUIDE.md)
## Installation
### Minimum Requirements
* Python 3.7+
[Step-by-step instructions](./documents/PREREQUISITES.md)
### Install from PyPI
#### MacOS and Linux:
```
python3 -m pip install awsiotsdk
```
#### Windows:
```
python -m pip install awsiotsdk
```
### Install from source
```bash
# 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](samples)
### 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](https://github.com/aws/aws-iot-device-sdk-python-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-python-v2/issues/new/choose) for bug reports, or feature requests. You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-iot) with the tag [#aws-iot](https://stackoverflow.com/questions/tagged/aws-iot) or if you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.
Please make sure to check out our resources too before opening an issue:
* [FAQ](./documents/FAQ.md)
* [API Docs](https://aws.github.io/aws-iot-device-sdk-python-v2/)
* [IoT Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs))
* Check for similar [Issues](https://github.com/aws/aws-iot-device-sdk-python-v2/issues)
* [AWS IoT Core Documentation](https://docs.aws.amazon.com/iot/)
* [Dev Blog](https://aws.amazon.com/blogs/?awsf.blog-master-iot=category-internet-of-things%23amazon-freertos%7Ccategory-internet-of-things%23aws-greengrass%7Ccategory-internet-of-things%23aws-iot-analytics%7Ccategory-internet-of-things%23aws-iot-button%7Ccategory-internet-of-things%23aws-iot-device-defender%7Ccategory-internet-of-things%23aws-iot-device-management%7Ccategory-internet-of-things%23aws-iot-platform)
* Integration with AWS IoT Services such as
[Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html)
and [Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html)
is provided by code that been generated from a model of the service.
* [Contributions Guidelines](./documents/CONTRIBUTING.md)
## License
This library is licensed under the [Apache 2.0 License](./documents/LICENSE).
Latest released version: v1.22.1
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-iot-device-sdk-python-v2",
"name": "awsiotsdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "AWS SDK Common Runtime Team",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/32/46/63c88a553578a48aa156f6f7408e5154e5b71db8bdde25f31ce86fa3635e/awsiotsdk-1.22.1.tar.gz",
"platform": null,
"description": "# AWS IoT Device SDK v2 for Python\n\n[](https://pypi.org/project/awsiotsdk/)\n\nThis document provides information about the AWS IoT Device SDK v2 for Python. This SDK is built on the [AWS Common Runtime](https://docs.aws.amazon.com/sdkref/latest/guide/common-runtime.html)\n\n*__Jump To:__*\n* [Installation](#installation)\n* [Samples](samples)\n* [Mac-Only TLS Behavior](#mac-only-tls-behavior)\n* [Getting Help](#getting-help)\n* [FAQ](./documents/FAQ.md)\n* [API Docs](https://aws.github.io/aws-iot-device-sdk-python-v2/)\n* [MQTT5 User Guide](./documents/MQTT5_Userguide.md)\n* [Migration Guide from the AWS IoT SDK for Python v1](./documents/MIGRATION_GUIDE.md)\n\n\n## Installation\n\n### Minimum Requirements\n* Python 3.7+\n\n[Step-by-step instructions](./documents/PREREQUISITES.md)\n\n### Install from PyPI\n\n#### MacOS and Linux:\n\n```\npython3 -m pip install awsiotsdk\n```\n\n#### Windows:\n\n```\npython -m pip install awsiotsdk\n```\n\n### Install from source\n\n```bash\n# 1. Create a workspace directory to hold all the SDK files\nmkdir sdk-workspace\ncd sdk-workspace\n\n# 2. Clone the repository. You could select the version of the SDK you desire to use.\ngit clone -b <SDK_VERSION> https://github.com/aws/aws-iot-device-sdk-python-v2.git\n\n# 3. (Optional) Setup the version number of your local build. The default version \n# for awsiotsdk is set to \"1.0.0-dev\", you can set the version number of the\n# local build in \"aws-iot-device-sdk-python-v2/awsiot/__init__.py\"\nsed -i \"s/__version__ = '1.0.0-dev'/__version__ = '<SDK_VERSION>'/\" \\\n aws-iot-device-sdk-python-v2/awsiot/__init__.py\n\n# 4. Install using Pip (use 'python' instead of 'python3' on Windows)\npython3 -m pip install ./aws-iot-device-sdk-python-v2\n```\n\n## Samples\n\n[Samples README](samples)\n\n### Mac-Only TLS Behavior\n\nPlease 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:\n\n```\nstatic: certificate has an existing certificate-key pair that was previously imported into the Keychain. Using key from Keychain instead of the one provided.\n```\n\n## Getting Help\n\nThe best way to interact with our team is through GitHub. You can open a [discussion](https://github.com/aws/aws-iot-device-sdk-python-v2/discussions) for guidance questions or an [issue](https://github.com/aws/aws-iot-device-sdk-python-v2/issues/new/choose) for bug reports, or feature requests. You may also find help on community resources such as [StackOverFlow](https://stackoverflow.com/questions/tagged/aws-iot) with the tag [#aws-iot](https://stackoverflow.com/questions/tagged/aws-iot) or if you have a support plan with [AWS Support](https://aws.amazon.com/premiumsupport/), you can also create a new support case.\n\nPlease make sure to check out our resources too before opening an issue:\n\n* [FAQ](./documents/FAQ.md)\n* [API Docs](https://aws.github.io/aws-iot-device-sdk-python-v2/)\n* [IoT Guide](https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html) ([source](https://github.com/awsdocs/aws-iot-docs))\n* Check for similar [Issues](https://github.com/aws/aws-iot-device-sdk-python-v2/issues)\n* [AWS IoT Core Documentation](https://docs.aws.amazon.com/iot/)\n* [Dev Blog](https://aws.amazon.com/blogs/?awsf.blog-master-iot=category-internet-of-things%23amazon-freertos%7Ccategory-internet-of-things%23aws-greengrass%7Ccategory-internet-of-things%23aws-iot-analytics%7Ccategory-internet-of-things%23aws-iot-button%7Ccategory-internet-of-things%23aws-iot-device-defender%7Ccategory-internet-of-things%23aws-iot-device-management%7Ccategory-internet-of-things%23aws-iot-platform)\n* Integration with AWS IoT Services such as\n[Device Shadow](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html)\nand [Jobs](https://docs.aws.amazon.com/iot/latest/developerguide/iot-jobs.html)\nis provided by code that been generated from a model of the service.\n* [Contributions Guidelines](./documents/CONTRIBUTING.md)\n\n## License\n\nThis library is licensed under the [Apache 2.0 License](./documents/LICENSE).\n\nLatest released version: v1.22.1\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: Apache Software License",
"summary": "AWS IoT SDK based on the AWS Common Runtime",
"version": "1.22.1",
"project_urls": {
"Homepage": "https://github.com/aws/aws-iot-device-sdk-python-v2"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe373c24543460116e4332530d79df0601ed7c849f889fbf7044b1841d98b57f",
"md5": "60af98d3bc1f8e2a354b8bc1f16b06a0",
"sha256": "ff10c02deb52fe2eacd72201fd1cd723d688b69199651aaf4f3969577bc997f9"
},
"downloads": -1,
"filename": "awsiotsdk-1.22.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60af98d3bc1f8e2a354b8bc1f16b06a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 75269,
"upload_time": "2024-12-16T21:12:26",
"upload_time_iso_8601": "2024-12-16T21:12:26.831530Z",
"url": "https://files.pythonhosted.org/packages/fe/37/3c24543460116e4332530d79df0601ed7c849f889fbf7044b1841d98b57f/awsiotsdk-1.22.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "324663c88a553578a48aa156f6f7408e5154e5b71db8bdde25f31ce86fa3635e",
"md5": "e9f31f729390048ced56f22a13fc2a4c",
"sha256": "2ed9305cdc02a752aea5148e1fba8e2e0bd39bf34d9d77886366f1c5165dc3c8"
},
"downloads": -1,
"filename": "awsiotsdk-1.22.1.tar.gz",
"has_sig": false,
"md5_digest": "e9f31f729390048ced56f22a13fc2a4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 78440,
"upload_time": "2024-12-16T21:12:27",
"upload_time_iso_8601": "2024-12-16T21:12:27.931798Z",
"url": "https://files.pythonhosted.org/packages/32/46/63c88a553578a48aa156f6f7408e5154e5b71db8bdde25f31ce86fa3635e/awsiotsdk-1.22.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 21:12:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-iot-device-sdk-python-v2",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "awsiotsdk"
}