Metadata-Version: 2.4
Name: iotconnect-lib
Version: 2.0.0
Summary: Avnet IoTConnect SDK Library
Author-email: Nik Markovic <nikola.markovic@avnet.com>
Project-URL: Homepage, https://github.com/avnet-iotconnect/iotc-python-lib
Keywords: IoTconnect,AWS,IoTCore,Azure,IoTHub,Greengrass
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Dynamic: license-file


> This document is reformatted to better viewing as a standalone document.
> We recommend visiting this [GitHub v2.0.0 link](https://github.com/avnet-iotconnect/iotc-python-lib/blob/v2.0.0/) for best experience.

# Introduction
This project is the library that abstracts the /IOTCONNECT protocols for the SDKs like the
[/IOTCONNECT Python Lite SDK](https://github.com/avnet-iotconnect/iotc-python-lite-sdk)
and the [/IOTCONNECT Greengrass SDK](https://github.com/avnet-iotconnect/iotc-python-greengrass-sdk).

This library should generally not be used in other projects as the SDKs should be able 
to provide all the functionality that you would need in your python applications.

# Features

The library provides common code for interacting with /IOTCONNECT MQTT and HTTP device connectivity services:
* Format Telemetry (Reporting) messages
* Provide events for OTA and Command processing
* Streamline OTA and Command acknowledgements
* Obtain Discovery and Identity information

# Using The Library

To use this library in your project, ensure that your pyton project depends on iotconnect-lib.
Use a fixed major version dependency (E.g. "iotconnect-lib<2.0.0".) to 
avoid potential major version breaking your application calls.

The best way to learn how to use this library is to examine the unit test usage examples
in the [tests](https://github.com/avnet-iotconnect/iotc-python-lib/blob/v2.0.0/tests) directory or use the SDK implementations listed above in this document
for reference. 

# Testing

Regression tests should be run with every release using pytest.   

See [tests/TESTS_CONFIGURATION.md](https://github.com/avnet-iotconnect/iotc-python-lib/blob/v2.0.0/tests/TESTS_CONFIGURATION.md) for more details.

# Licensing

This python package is distributed under the [MIT License](https://github.com/avnet-iotconnect/iotc-python-lib/blob/v2.0.0/LICENSE.md).


