Skip to content

Commit a98903d

Browse files
authored
Update README.rst
1 parent 666f2b1 commit a98903d

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
Timeplus Proton Python Driver
1+
Timeplus Python Driver
22
=============================
33

44
Introduction
55
------------
66

7-
`Proton <https://github.com/timeplus-io/proton>`_ is a unified streaming and historical data processing engine in a single binary. The historical store is built based on `ClickHouse <https://github.com/ClickHouse/ClickHouse>`_.
7+
`Timeplus <https://github.com/timeplus-io/proton>`_ is a unified streaming and historical data processing engine in a single binary.
88

9-
This project provides python driver to interact with Proton, the code is based on https://github.com/mymarilyn/clickhouse-driver.
9+
This project provides python driver to interact with Timeplus Proton or Timeplus Enterprise, the code is based on https://github.com/mymarilyn/clickhouse-driver.
1010

1111

1212
Installation
1313
------------
14-
Proton Python Driver currently supports the following versions of Python: 3.8, 3.9, 3.10, 3.11 and 3.12.
14+
Timeplus Python Driver currently supports the following versions of Python: 3.8, 3.9, 3.10, 3.11 and 3.12.
1515

1616
Installing with pip
1717
We recommend creating a virtual environment when installing Python dependencies. For more information on setting up a virtual environment, see the `Python documentation <https://docs.python.org/3.9/tutorial/venv.html>`_.
1818

1919
.. code-block:: shell
2020
21-
pip install proton-driver
21+
pip install proton-driver --extra-index-url https://d.timeplus.com/simple/
2222
2323
2424
Quick Start
2525
------------
2626

27-
1. Run proton with docker. Make sure the port 8463 is exposed.
27+
1. Run Timeplus Proton with docker. Make sure the port 8463 is exposed.
2828

2929
.. code-block:: shell
3030
31-
docker run -d -p 8463:8463 --pull always --name proton ghcr.io/timeplus-io/proton:latest
31+
docker run -d -p 8463:8463 --pull always --name proton d.timeplus.com/timeplus-io/proton:latest
3232
3333
2. Run following python code
3434

0 commit comments

Comments
 (0)