From 42e66c09ddadfa0658211d9296654b37b05abe1d Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Tue, 24 Jan 2023 14:32:42 +0800 Subject: [PATCH] docs: update python connector document to reflect python version requirement change (#19664) * docs: update csharp connector status * docs: fix csharp ws bulk pulling * docs: clarify database param is optional to websocket dsn * docs: fix python version and a few typos * docs: fix jdbc version in connector matrix * docs: update jdbc demo readme * docs: update dot-net examples link * docs: fix example code mistake * fix: examples/csharp typos * fix: examples/python/native_insert_example.py mistake * docs: update python connector document to reflect python version requirement change * docs: update with two ways to install taos-ws-py --- .../en/14-reference/03-connector/07-python.mdx | 18 +++++++++++++++++- docs/zh/08-connector/30-python.mdx | 15 ++++++++++++--- 2 files changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/en/14-reference/03-connector/07-python.mdx b/docs/en/14-reference/03-connector/07-python.mdx index 25e6b2188a..d593c3f133 100644 --- a/docs/en/14-reference/03-connector/07-python.mdx +++ b/docs/en/14-reference/03-connector/07-python.mdx @@ -32,7 +32,7 @@ We recommend using the latest version of `taospy`, regardless of the version of ### Preparation -1. Install Python. Python >= 3.7 is recommended. If Python is not available on your system, refer to the [Python BeginnersGuide](https://wiki.python.org/moin/BeginnersGuide/Download) to install it. +1. Install Python. The recent taospy package requires Python 3.6+. The earlier versions of taospy require Python 3.7+. The taos-ws-py package requires Python 3.7+. If Python is not available on your system, refer to the [Python BeginnersGuide](https://wiki.python.org/moin/BeginnersGuide/Download) to install it. 2. Install [pip](https://pypi.org/project/pip/). In most cases, the Python installer comes with the pip utility. If not, please refer to [pip documentation](https://pip.pypa.io/en/stable/installation/) to install it. If you use a native connection, you will also need to [Install Client Driver](/reference/connector#Install-Client-Driver). The client install package includes the TDengine client dynamic link library (`libtaos.so` or `taos.dll`) and the TDengine CLI. @@ -78,6 +78,22 @@ pip3 install git+https://github.com/taosdata/taos-connector-python.git +#### Install `taos-ws-py` (Optional) + +The taos-ws-py package provides the way to access TDengine via WebSocket. + +##### Install taos-ws-py with taospy + +```bash +pip3 install taospy[ws] +``` + +##### Install taos-ws-py only + +```bash +pip3 install taos-ws-py +``` + ### Verify diff --git a/docs/zh/08-connector/30-python.mdx b/docs/zh/08-connector/30-python.mdx index 0958fc68ad..1962df9607 100644 --- a/docs/zh/08-connector/30-python.mdx +++ b/docs/zh/08-connector/30-python.mdx @@ -32,7 +32,7 @@ Python 连接器的源码托管在 [GitHub](https://github.com/taosdata/taos-con ### 准备 -1. 安装 Python。建议使用 Python >= 3.7。如果系统上还没有 Python 可参考 [Python BeginnersGuide](https://wiki.python.org/moin/BeginnersGuide/Download) 安装。 +1. 安装 Python。新近版本 taospy 包要求 Python 3.6+。早期版本 taospy 包要求 Python 3.7+。taos-ws-py 包要求 Python 3.7+。如果系统上还没有 Python 可参考 [Python BeginnersGuide](https://wiki.python.org/moin/BeginnersGuide/Download) 安装。 2. 安装 [pip](https://pypi.org/project/pip/)。大部分情况下 Python 的安装包都自带了 pip 工具， 如果没有请参考 [pip documentation](https://pip.pypa.io/en/stable/installation/) 安装。 3. 如果使用原生连接，还需[安装客户端驱动](../#安装客户端驱动)。客户端软件包含了 TDengine 客户端动态链接库(libtaos.so 或 taos.dll) 和 TDengine CLI。 @@ -78,11 +78,20 @@ pip3 install git+https://github.com/taosdata/taos-connector-python.git -#### 安装 `taos-ws`(可选) +#### 安装 `taos-ws-py`（可选） -taos-ws 提供了通过 websocket 连接 TDengine 的能力，可选安装 taos-ws 以获得 websocket 连接 TDengine 的能力。 +taos-ws-py 包提供了通过 WebSocket 连接 TDengine 的能力，可选安装 taos-ws-py 以获得 WebSocket 连接 TDengine 的能力。 + +##### 和 taospy 同时安装 + +```bash +pip3 install taospy[ws] ``` + +##### 单独安装 + +```bash pip3 install taos-ws-py ```