简体中文 | English
taospy 是 TDengine 官方 Python 连接器，允许 Python 开发人员访问 TDengine 数据库的应用程序, 支持数据普通写入、无模式写入、参数绑定写入、查询及订阅等功能。
taospy 的 API 符合 Python DB API 2.0（PEP-249） 规范，主要由两个模块组成：
taos模块, 它使用 TDengine C 客户端库进行客户端-服务器间通信。taorsest模块, 它使用 TDengine RESTful API ，API 符合 Python DB API 2.0（PEP-249）规范, 使用此模块，您不需要再安装 TDengine C 客户端库。
- 使用
Python 连接器, 请参考 开发指南，包含了应用如何引入Python 连接器及数据写入、查询及数据订阅等示例。 - 其他参考信息请看 参考手册，包含了版本历史、数据类型、示例程序汇总、API 说明和常见问题等。
- 本 README 主要是为想自己贡献、编译、测试
Python 连接器的开发者写的。如果要学习 TDengine，可以浏览 官方文档。
- Python 运行环境 (taospy: Python >= 3.6.2, taos-ws-py: Python >= 3.7)。
- 本地已部署 TDengine，具体步骤请参考 部署服务端，且已经启动 taosd 与 taosAdapter。
下载代码库并在根目录中执行以下操作以构建开发环境：
pip3 install -e ./ Python 连接器测试用例使用 pytest 测试框架。
组件 taospy 测试用例目录是: tests/
组件 taos-ws-py 测试用例目录是: taos-ws-py/tests/
搭建本地测试环境及运行测试用例的代码已封装在一个脚本文件中，执行以下命令即可轻松搭建及执行测试用例：
# for taospy
bash ./test_taospy.sh
# for taos-ws-py
bash ./test_taos-ws-py.sh您可以添加新测试文件或在现有测试文件中添加符合 pytest 标准的测试用例。
性能测试还在开发中。
我们欢迎提交 GitHub Issue。 提交时请说明下面信息：
- 问题描述，是否必现，最好能包含详细调用堆栈。
- Python 连接器版本。
- Python 连接器连接参数（不需要用户名密码）。
- TDengine 服务端版本。
我们欢迎开发者一起开发本项目，提交 PR 时请参考下面步骤：
- Fork 本项目，请参考 (how to fork a repo)。
- 从 main 分支创建一个新分支，请使用有意义的分支名称 (
git checkout -b my_branch)。注意不要直接在 main 分支上修改。 - 修改代码，保证所有单元测试通过，并增加新的单元测试验证修改。
- 提交修改到远端分支 (
git push origin my_branch)。 - 在 GitHub 上创建一个 Pull Request (how to create a pull request)。
- 提交 PR 后，可以通过 Pull Request 找到自己的 PR，点击对应链接进去可以看到自己 PR CI 是否通过，如果通过会显示 “All checks have passed”。无论 CI 是否通过，都可以点击 “Show all checks” -> “Details” 来查看详细用例日志。
- 提交 PR 后，如果 CI 通过，可以在 codecov 页面找到自己 PR，看单测覆盖率。