Improvements

Author: imbeacon

README.md

@@ -1,13 +1,14 @@
-# ThingsBoard REST API client
+# ThingsBoard Python REST API client
 
 
-The ThingsBoard REST API Client helps you interact with ThingsBoard REST API from your Python script.  
-With Rest Client you can programmatically create assets, devices, customers, users and other entities and their relations in ThingsBoard.
+The ThingsBoard REST API Client helps you interact with [ThingsBoard REST API](https://thingsboard.io/docs/reference/rest-api/) from your Python script.  
+With [Python Rest Client](https://thingsboard.io/docs/reference/python-rest-client/) you can programmatically create assets, devices, customers, users and other entities and their relations in ThingsBoard.
 
 The recommended method for installing the Rest Client is a pip.  
 
 *The Python version of the REST API client is under developing. If you have discovered any bug, please write us using email or by opening the issue.*
 
+
 ##### Installation 
 
 In order to install the ThingsBoard REST client, you should use the following command:
@@ -16,23 +17,25 @@ In order to install the ThingsBoard REST client, you should use the following co
 pip3 install tb-rest-client
 ``` 
 
+
 ##### Examples 
 
-You can find the examples of the usage in the "examples" folder or on the [our site](https://thingsboard.io/docs/reference/python-rest-client/).
+You can find the examples of the usage in the "examples" folder or on the [our website](https://thingsboard.io/docs/reference/python-rest-client/).
 
 
 **Notate:** There are 2 REST clients for ThingsBoard, they are depend on version of the ThingsBoard, you use.  
 
- - If you use the ThingsBoard Community Edition (ThingsBoard CE) - please use the following command to import the REST client into your script:
-   `from tb_rest_client.rest_client_ce import *`
-   The REST client class has name "RestClientCE".
+ - If you use the ThingsBoard Community Edition (ThingsBoard CE) - please use the following command to import the REST client into your script:  
+   `from tb_rest_client.rest_client_ce import *`  
+   The REST client class has name "RestClientCE".  
 
- - If you use the ThingsBoard Professional Edition (ThingsBoard PE) - please use the following command to import the REST client into your script:
-   `from tb_rest_client.rest_client_pe import *`
-   The REST client class has name "RestClientPE".
+ - If you use the ThingsBoard Professional Edition (ThingsBoard PE) - please use the following command to import the REST client into your script:  
+   `from tb_rest_client.rest_client_pe import *`  
+   The REST client class has name "RestClientPE".  
 
 If you use the wrong version of the REST client, it could work unexpectedly.
 
+
 ## Support
 
  - [Community chat](https://gitter.im/thingsboard/chat)
@@ -41,6 +44,7 @@ If you use the wrong version of the REST client, it could work unexpectedly.
 
 **Don't forget to star the repository to show your ❤️ and support.**
 
+
 ## Licenses
 
 This project is released under [Apache 2.0 License](./LICENSE).

examples/example_application.py

@@ -14,6 +14,7 @@
 #
 
 import logging
+# Importing models and REST client class from Community Edition version
 from tb_rest_client.rest_client_ce import *
 from tb_rest_client.rest import ApiException
 
@@ -22,24 +23,33 @@
                     format='%(asctime)s - %(levelname)s - %(module)s - %(lineno)d - %(message)s',
                     datefmt='%Y-%m-%d %H:%M:%S')
 
+# ThingsBoard REST API URL
 url = "http://localhost:8080"
+
+# Default Tenant Administrator credentials
 username = "tenant@thingsboard.org"
 password = "tenant"
 
+
+# Creating the REST client object with context manager to get auto token refresh
 with RestClientCE(base_url=url) as rest_client:
     try:
+        # Auth with credentials
         rest_client.login(username=username, password=password)
 
+        # Creating an Asset
         asset = Asset(name="Building 1", type="building")
         asset = rest_client.save_asset(asset)
 
         logging.info("Asset was created:\n%r\n", asset)
 
+        # creating a Device
         device = Device(name="Thermometer 1", type="thermometer")
         device = rest_client.save_device(device)
 
         logging.info(" Device was created:\n%r\n", device)
 
+        # Creating relations from device to asset
         relation = EntityRelation(_from=asset.id, to=device.id, type="Contains")
         relation = rest_client.save_relation(relation)
 

examples/example_application_2.py

@@ -15,6 +15,7 @@
 
 import logging
 from json import load
+# Importing models and REST client class from Professional Edition version
 from tb_rest_client.rest_client_pe import *
 from tb_rest_client.rest import ApiException
 
@@ -24,15 +25,23 @@
                     datefmt='%Y-%m-%d %H:%M:%S')
 
 
+# ThingsBoard REST API URL
 url = "http://localhost:8080"
+
+# Default Tenant Administrator credentials
 username = "tenant@thingsboard.org"
 password = "tenant"
 
 
+# Creating the REST client object with context manager to get auto token refresh
 with RestClientPE(base_url=url) as rest_client:
     try:
+        # Auth with credentials
         rest_client.login(username=username, password=password)
+
+        # Getting current user
         current_user = rest_client.get_user()
+
         # Creating Dashboard Group on the Tenant Level
         shared_dashboards_group = EntityGroup(name="Shared Dashboards", type="DASHBOARD")
         shared_dashboards_group = rest_client.save_entity_group(shared_dashboards_group)
@@ -76,7 +85,6 @@
         # Creating User for Customer 1 with default dashboard from Tenant "Shared Dashboards" group.
         user_email = "user@thingsboard.org"
         user_password = "secret"
-
         additional_info = {
             "defaultDashboardId": dashboard.id.id,
             "defaultDashboardFullscreen": False
@@ -87,6 +95,7 @@
                     additional_info=additional_info)
         user = rest_client.save_user(user, send_activation_mail=False)
         rest_client.activate_user(user.id, user_password)
+
         rest_client.add_entities_to_entity_group(customer1_administrators.id, [user.id.id])
 
     except ApiException as e: