From a431572d7ac49dced1ca03b758b780a24201c1cb Mon Sep 17 00:00:00 2001 From: sky-sharma Date: Tue, 23 Sep 2025 15:52:04 -0700 Subject: [PATCH 1/2] Correct broken docs links and improve README (#45) * Tried to clarify differences between IoT Core and IoT Enterprise; corrected docs links * Formatting * Formatting * Formatting * Formatting * Formatting * Formatting * Formatting * Formatting * Formatting * Added link to explain IoT Core Standard vs Enterprise * Improved link explaining differences between IoT Core Standard & Enterprise * setup.py; ver 2.0.6 -> 2.0.7 --------- Co-authored-by: sky-sharma --- README.rst | 25 +++++++++++++++++++++---- setup.py | 2 +- 2 files changed, 22 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index a7753b18..3e95a9cd 100644 --- a/README.rst +++ b/README.rst @@ -3,17 +3,34 @@ Python Client for ClearBlade IoT Core API Quick start ----------- -**Note: This SDK is for use with ClearBlade IoT Core and NOT ClearBlade IoT Enterprise. The Python SDK for ClearBlade IoT Enterprise can be found here: https://github.com/ClearBlade/ClearBlade-Python-SDK/.** +**Notes** -To use this library, you first need to go through the following steps: +1. This SDK is for use with ClearBlade IoT Core Standard and ClearBlade IoT Core Enterprise. + +2. ClearBlade IoT **Core** Enterprise is DIFFERENT from ClearBlade IoT Enterprise!!! + +3. If you are using ClearBlade but not using ClearBlade IoT Core (Standard or Enterprise), then you need a different SDK that can be found `here `_. + +4. To understand how IoT Core Enterprise differs from Standard, look `here `_. + + + +To use this SDK, you first need to go through the following steps: 1. Install pip package - ```pip install clearblade-cloud-iot``` -2. Set an environment variable **CLEARBLADE_CONFIGURATION**, pointing to your ClearBlade service account JSON file. Look `here`_ for how to create a service account and download a credentials JSON file. +2. Set an environment variable **CLEARBLADE_CONFIGURATION**, pointing to your ClearBlade service account JSON file (see below). 3. Optionally set an environment variable **BINARYDATA_AND_TIME_GOOGLE_FORMAT** to True. Look at **Note about types of times and binaryData** below for details. -.. _`here`: https://clearblade.atlassian.net/wiki/spaces/IC/pages/2240675843/Add+service+accounts+to+a+project + +To create a service account and download a credentials JSON file look at the appropriate link below: + +`ClearBlade IoT Core Standard `_ + +`ClearBlade IoT Core Enterprise `_ + + Installation ~~~~~~~~~~~~ diff --git a/setup.py b/setup.py index e31e60ff..56ba1951 100644 --- a/setup.py +++ b/setup.py @@ -32,7 +32,7 @@ name = "clearblade-cloud-iot" description = "Cloud IoT API client library" -version = "2.0.6" +version = "2.0.7" release_status = "Development Status :: 5 - Production/Stable" dependencies = ["httpx", "proto-plus"] From c64c1dc60326a07099e12f721dd2ffc364ddb870 Mon Sep 17 00:00:00 2001 From: sky-sharma Date: Wed, 24 Sep 2025 05:05:56 -0700 Subject: [PATCH 2/2] README different link format (#46) Co-authored-by: sky-sharma --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 3e95a9cd..372f5a91 100644 --- a/README.rst +++ b/README.rst @@ -9,9 +9,9 @@ Quick start 2. ClearBlade IoT **Core** Enterprise is DIFFERENT from ClearBlade IoT Enterprise!!! -3. If you are using ClearBlade but not using ClearBlade IoT Core (Standard or Enterprise), then you need a different SDK that can be found `here `_. +3. If you are using ClearBlade but not using ClearBlade IoT Core (Standard or Enterprise), then you need this different SDK: ``_. -4. To understand how IoT Core Enterprise differs from Standard, look `here `_. +4. To understand how IoT Core Enterprise differs from Standard, look here: ``_.