tb-rest-client 3.6.2__tar.gz → 3.9.0__tar.gz

tb_rest_client-3.9.0/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.1
+Name: tb-rest-client
+Version: 3.9.0
+Summary: ThingsBoard REST API client
+Home-page: https://thingsboard.io/docs/reference/python-rest-client/
+License: Apache-2.0
+Keywords: tb-python-rest-client,tb-rest-client
+Author: ThingsBoard
+Author-email: info@thingsboard.io
+Maintainer: Illia Barkov
+Maintainer-email: ibarkov@thingsboard.io
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+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
+Requires-Dist: certifi (==2023.7.22)
+Requires-Dist: pyjwt (==2.6.0)
+Requires-Dist: python_dateutil (==2.5.3)
+Requires-Dist: requests (==2.31.0)
+Requires-Dist: setuptools (==21.0.0)
+Requires-Dist: six (==1.10)
+Requires-Dist: urllib3 (==2.0.7)
+Project-URL: Documentation, https://thingsboard.io/docs/reference/python-rest-client/
+Project-URL: Repository, https://github.com/thingsboard/thingsboard-python-rest-client
+Description-Content-Type: text/markdown
+
+# ThingsBoard Python REST API client
+
+
+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:
+
+```bash
+pip3 install tb-rest-client
+``` 
+
+
+##### Examples 
+
+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/).
+
+
+**Note:** 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 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)
+ - [Q&A forum](https://groups.google.com/forum/#!forum/thingsboard)
+ - [Stackoverflow](http://stackoverflow.com/questions/tagged/thingsboard)
+ 
+**Don't forget to star the repository to show your ❤️ and support.**
+
+
+## Licenses
+
+This project is released under [Apache 2.0 License](./LICENSE).
+

tb_rest_client-3.9.0/pyproject.toml

@@ -0,0 +1,30 @@
+[tool.poetry]
+name = "tb-rest-client"
+version = "3.9.0"
+description = "ThingsBoard REST API client"
+authors = ["ThingsBoard <info@thingsboard.io>"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://thingsboard.io/docs/reference/python-rest-client/"
+repository = "https://github.com/thingsboard/thingsboard-python-rest-client"
+documentation = "https://thingsboard.io/docs/reference/python-rest-client/"
+keywords = ["tb-python-rest-client", "tb-rest-client"]
+maintainers = [
+    "Illia Barkov <ibarkov@thingsboard.io>",
+    "Vitalii Bidochka <vbidochka@thingsboard.io>"
+]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+certifi = "2023.7.22"
+six = "1.10"
+python_dateutil = "2.5.3"
+setuptools = "21.0.0"
+urllib3 = "2.0.7"
+requests = "2.31.0"
+pyjwt = "2.6.0"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

tb_rest_client-3.9.0/tb_rest_client/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright 2025. ThingsBoard
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from .rest_client_ce import RestClientCE
+from .rest_client_pe import RestClientPE

tb_rest_client-3.9.0/tb_rest_client/api/__init__.py

@@ -0,0 +1,14 @@
+#  Copyright 2025. ThingsBoard
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+

tb_rest_client-3.9.0/tb_rest_client/api/api_ce/__init__.py

@@ -0,0 +1,66 @@
+#  Copyright 2025. ThingsBoard
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from __future__ import absolute_import
+
+from .o_auth_2_config_template_controller_api import OAuth2ConfigTemplateControllerApi
+from .asset_controller_api import AssetControllerApi
+from .rule_chain_controller_api import RuleChainControllerApi
+from .auth_controller_api import AuthControllerApi
+from .event_controller_api import EventControllerApi
+from .telemetry_controller_api import TelemetryControllerApi
+from .alarm_controller_api import AlarmControllerApi
+from .edge_controller_api import EdgeControllerApi
+from .rpc_v_2_controller_api import RpcV2ControllerApi
+from .edge_event_controller_api import EdgeEventControllerApi
+from .customer_controller_api import CustomerControllerApi
+from .user_controller_api import UserControllerApi
+from .queue_controller_api import QueueControllerApi
+from .rpc_v_1_controller_api import RpcV1ControllerApi
+from .device_controller_api import DeviceControllerApi
+from .entity_relation_controller_api import EntityRelationControllerApi
+from .entity_view_controller_api import EntityViewControllerApi
+from .admin_controller_api import AdminControllerApi
+from .tb_resource_controller_api import TbResourceControllerApi
+from .o_auth_2_controller_api import OAuth2ControllerApi
+from .tenant_profile_controller_api import TenantProfileControllerApi
+from .widgets_bundle_controller_api import WidgetsBundleControllerApi
+from .device_profile_controller_api import DeviceProfileControllerApi
+from .dashboard_controller_api import DashboardControllerApi
+from .entity_query_controller_api import EntityQueryControllerApi
+from .widget_type_controller_api import WidgetTypeControllerApi
+from .audit_log_controller_api import AuditLogControllerApi
+from .lwm_2m_controller_api import Lwm2mControllerApi
+from .component_descriptor_controller_api import ComponentDescriptorControllerApi
+from .tenant_controller_api import TenantControllerApi
+from .ota_package_controller_api import OtaPackageControllerApi
+from .entities_version_control_controller_api import EntitiesVersionControlControllerApi
+from .device_api_controller_api import DeviceApiControllerApi
+from .two_factor_auth_controller_api import TwoFactorAuthControllerApi
+from .alarm_comment_controller_api import AlarmCommentControllerApi
+from .asset_profile_controller_api import AssetProfileControllerApi
+from .notification_controller_api import NotificationControllerApi
+from .notification_rule_controller_api import NotificationRuleControllerApi
+from .notification_target_controller_api import NotificationTargetControllerApi
+from .notification_template_controller_api import NotificationTemplateControllerApi
+from .usage_info_controller_api import UsageInfoControllerApi
+from .two_factor_auth_config_controller_api import TwoFactorAuthConfigControllerApi
+from .image_controller_api import ImageControllerApi
+from .mobile_application_controller_api import MobileApplicationControllerApi
+from .queue_stats_controller_api import QueueStatsControllerApi
+from .domain_controller_api import DomainControllerApi
+from .mobile_app_controller_api import MobileAppControllerApi
+from .mobile_app_bundle_controller_api import MobileAppBundleControllerApi
+from .qr_code_settings_controller_api import QrCodeSettingsControllerApi
+from .rule_engine_controller_api import RuleEngineControllerApi