Skip to content

Fix nonexistent file paths in Python client README and correct doc typos #18797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HTHou merged 1 commit into from
Oct 8, 2026
Merged

Fix nonexistent file paths in Python client README and correct doc typos #18797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docker/ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ apache-iotdb-2.0.11-SNAPSHOT-all-bin.zip
apache-iotdb-2.0.11-SNAPSHOT-ainode-bin.zip
```

To avoid mannually copy these files, you can run our `do-docker-build.sh` with argument `-b`.
To avoid manually copy these files, you can run our `do-docker-build.sh` with argument `-b`.

# How to run IoTDB server

Expand All @@ -85,7 +85,7 @@ docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555
```shell
docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555 -p 9003:9003 -p 40010:40010 apache/iotdb:<version>
```
Since 1.0.0, see [offical documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html)
Since 1.0.0, see [official documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html)

# How to register AINode to IoTDB cluster

Expand Down
6 changes: 3 additions & 3 deletions iotdb-client/client-py/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You have to install thrift (>=0.14.1) before using the package.

First, download the latest package: `pip3 install apache-iotdb`

You can get an example of using the package to read and write data at here: [Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/SessionExample.py)
You can get an example of using the package to read and write data at here: [Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/session_example.py)

An example of aligned timeseries: [Aligned Timeseries Session Example](https://github.com/apache/iotdb/blob/master/iotdb-client/client-py/SessionAlignedTimeseriesExample.py)

Expand Down Expand Up @@ -576,7 +576,7 @@ This folder is ignored from git and should **never be pushed to git!**

### Session Client & Example

We packed up the Thrift interface in `client-py/src/iotdb/Session.py` (similar with its Java counterpart), also provided an example file `client-py/src/SessionExample.py` of how to use the session module. please read it carefully.
We packed up the Thrift interface in `client-py/iotdb/Session.py` (similar with its Java counterpart), also provided an example file `client-py/session_example.py` of how to use the session module. please read it carefully.


Or, another simple example:
Expand Down Expand Up @@ -606,7 +606,7 @@ To run all defined tests just type `pytest .` in the root folder.



### Futher Tools
### Further Tools

[black](https://pypi.org/project/black/) and [flake8](https://pypi.org/project/flake8/) are installed for autoformatting and linting.
Both can be run by `black .` or `flake8 .` respectively.
Expand Down
Loading