https://github.com/thingsboard/thingsboard-python-rest-client
ThingsBoard REST API client
https://github.com/thingsboard/thingsboard-python-rest-client
python-rest-client python-tb-rest-client rest rest-api rest-client tb-rest-client thingsboard thingsboard-api thingsboard-ce thingsboard-pe thingsboard-rest-client
Last synced: 28 days ago
JSON representation
ThingsBoard REST API client
- Host: GitHub
- URL: https://github.com/thingsboard/thingsboard-python-rest-client
- Owner: thingsboard
- License: apache-2.0
- Created: 2020-06-09T09:04:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-20T07:37:49.000Z (about 2 months ago)
- Last Synced: 2025-04-02T05:02:41.307Z (about 1 month ago)
- Topics: python-rest-client, python-tb-rest-client, rest, rest-api, rest-client, tb-rest-client, thingsboard, thingsboard-api, thingsboard-ce, thingsboard-pe, thingsboard-rest-client
- Language: Python
- Homepage: https://thingsboard.io/docs/reference/python-rest-client/
- Size: 5.37 MB
- Stars: 80
- Watchers: 4
- Forks: 55
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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).