Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taosdata/taos-connector-python
TDengine connector for Python
https://github.com/taosdata/taos-connector-python
database driver iot python tdengine time-series
Last synced: 4 days ago
JSON representation
TDengine connector for Python
- Host: GitHub
- URL: https://github.com/taosdata/taos-connector-python
- Owner: taosdata
- License: mit
- Created: 2021-08-16T05:24:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T12:48:57.000Z (4 months ago)
- Last Synced: 2024-09-18T13:29:24.667Z (4 months ago)
- Topics: database, driver, iot, python, tdengine, time-series
- Language: Python
- Homepage: https://www.taosdata.com/cn/documentation/connector#python
- Size: 1.02 MB
- Stars: 46
- Watchers: 24
- Forks: 12
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# TDengine Connector for Python
| Github Workflow | PyPI Version | PyPI Downloads | CodeCov |
| --------------- | ------------ | -------------- | ------- |
|  |  |  | [](https://codecov.io/gh/taosdata/taos-connector-python) |
[TDengine](https://github.com/taosdata/TDengine) connector for Python enables python programs to access TDengine, using
an API which is compliant with the Python DB API 2.0 (PEP-249). It contains two modules:
1. The `taos` module. It uses TDengine C client library for client server communications.
2. The `taosrest` module. It wraps TDengine RESTful API to Python DB API 2.0 (PEP-249). With this module, you do not need to install the TDengine C client library.
## Install taospy
You can use `pip` to install the connector from PyPI:
```bash
pip3 install taospy
```
Or with git url:
```bash
pip3 install git+https://github.com/taosdata/taos-connector-python.git
```
Note: taospy v2.7.2 requirs Python 3.6+. The early versions of taospy from v2.5.0 to v2.7.1 require Python 3.7+.
## Install taos-ws-py (Support WebSocket)
```bash
# taos-ws-py depends taospy
pip3 install taospy
pip3 install taos-ws-py
```
Note: The taosws module is provided by taos-ws-py package separately from v2.7.2. It is part of early version of taospy.
taos-ws-py requires Python 3.7+.
## Docs
[Reference](https://docs.tdengine.com/tdengine-reference/client-libraries/python/)
## Limitation
- `taosrest` is designed to use with taosAdapter. If your TDengine version is older than v2.4.0.0, taosAdapter may not
be available.
## License
We use MIT license for Python connector.
## Contributing
### For taospy
**1. Precondictions**
1. `TDengine` enviroment, install refer to [Here](https://www.taosdata.com/)
2. `Python3` enviroment, install refer to [Here](https://www.python.org/)
**2. Building & Install**
Download the repository code and execute the following in root directory:
``` bash
pip3 install ./
```
or install in editable mode (i.e. "develop mode")
``` bash
pip3 install -e ./
```
**3. Testing**
Refer to the examples in ./tests/
### For taos-ws-py
**1. Precondictions**
1. `TDengine` enviroment, install refer to [Here](https://www.taosdata.com/)
2. `Python3` enviroment, install refer to [Here](https://www.python.org/)
3. `Rust` build enviroment, install refer to [Here](https://www.rust-lang.org/learn/get-started)
4. Install `maturin` with `pip3 install maturin`
**2. Building & Install**
Download the repository code and execute the following in root directory:
```bash
# enter source code folder
cd taos-ws-py
# build
python3 -m maturin build --strip
# install repalce xxx with real generated filename
pip3 install ./target/wheels/taos_ws_py-xxx.whl
```
**3. Testing**
Refer to the examples in ./tests/