# 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).
Raw data
{
"_id": null,
"home_page": "https://thingsboard.io/docs/reference/python-rest-client/",
"name": "tb-rest-client",
"maintainer": "Illia Barkov",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "ibarkov@thingsboard.io",
"keywords": "tb-python-rest-client, tb-rest-client",
"author": "ThingsBoard",
"author_email": "info@thingsboard.io",
"download_url": "https://files.pythonhosted.org/packages/46/08/249666a1bd0325deb3c3716c1b02ad99714d1d4f4355d07082cb59a2e783/tb_rest_client-3.9.0.tar.gz",
"platform": null,
"description": "# ThingsBoard Python REST API client\n\n\nThe ThingsBoard REST API Client helps you interact with [ThingsBoard REST API](https://thingsboard.io/docs/reference/rest-api/) from your Python script. \nWith [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.\n\nThe recommended method for installing the Rest Client is a pip. \n\n*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.*\n\n\n##### Installation \n\nIn order to install the ThingsBoard REST client, you should use the following command:\n\n```bash\npip3 install tb-rest-client\n``` \n\n\n##### Examples \n\nYou can find the examples of the usage in the \"examples\" folder or on the [our website](https://thingsboard.io/docs/reference/python-rest-client/).\n\n\n**Note:** There are 2 REST clients for ThingsBoard, they are depend on version of the ThingsBoard, you use. \n\n - If you use the ThingsBoard Community Edition (ThingsBoard CE) - please use the following command to import the REST client into your script: \n `from tb_rest_client.rest_client_ce import *` \n The REST client class has name \"RestClientCE\". \n \n - If you use the ThingsBoard Professional Edition (ThingsBoard PE) - please use the following command to import the REST client into your script: \n `from tb_rest_client.rest_client_pe import *` \n The REST client class has name \"RestClientPE\". \n\nIf you use the wrong version of the REST client, it could work unexpectedly.\n\n\n## Support\n\n - [Community chat](https://gitter.im/thingsboard/chat)\n - [Q&A forum](https://groups.google.com/forum/#!forum/thingsboard)\n - [Stackoverflow](http://stackoverflow.com/questions/tagged/thingsboard)\n \n**Don't forget to star the repository to show your \u2764\ufe0f and support.**\n\n\n## Licenses\n\nThis project is released under [Apache 2.0 License](./LICENSE).\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "ThingsBoard REST API client",
"version": "3.9.0",
"project_urls": {
"Documentation": "https://thingsboard.io/docs/reference/python-rest-client/",
"Homepage": "https://thingsboard.io/docs/reference/python-rest-client/",
"Repository": "https://github.com/thingsboard/thingsboard-python-rest-client"
},
"split_keywords": [
"tb-python-rest-client",
" tb-rest-client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ecac8fc85debdd28260c9e511dd9c2c978a4b3fee498040543b105816b44b0c0",
"md5": "e536a2c8ba1b852a6f4cfc2f2f538ca9",
"sha256": "ff08c63351bf176790526a31d2fd8f2e5395c59380d62f30e846d8b84107d88f"
},
"downloads": -1,
"filename": "tb_rest_client-3.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e536a2c8ba1b852a6f4cfc2f2f538ca9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 2604099,
"upload_time": "2025-01-15T10:05:31",
"upload_time_iso_8601": "2025-01-15T10:05:31.069200Z",
"url": "https://files.pythonhosted.org/packages/ec/ac/8fc85debdd28260c9e511dd9c2c978a4b3fee498040543b105816b44b0c0/tb_rest_client-3.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4608249666a1bd0325deb3c3716c1b02ad99714d1d4f4355d07082cb59a2e783",
"md5": "583c2ae4883fb204ba0f58bbe28468ff",
"sha256": "a8747866e489e526a51d82e07b64fd2343b6f863f9571709d386cb490c2f59cb"
},
"downloads": -1,
"filename": "tb_rest_client-3.9.0.tar.gz",
"has_sig": false,
"md5_digest": "583c2ae4883fb204ba0f58bbe28468ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 955043,
"upload_time": "2025-01-15T10:05:33",
"upload_time_iso_8601": "2025-01-15T10:05:33.580771Z",
"url": "https://files.pythonhosted.org/packages/46/08/249666a1bd0325deb3c3716c1b02ad99714d1d4f4355d07082cb59a2e783/tb_rest_client-3.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 10:05:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thingsboard",
"github_project": "thingsboard-python-rest-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "certifi",
"specs": [
[
">=",
"2023.7.22"
]
]
},
{
"name": "six",
"specs": [
[
">=",
"1.10"
]
]
},
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"2.0.7"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.31.0"
]
]
},
{
"name": "pyjwt",
"specs": [
[
"==",
"2.6.0"
]
]
}
],
"lcname": "tb-rest-client"
}
JSON
