Skip to content

Commit c4ed4f0

Browse files
committed
update README
1 parent 42773ed commit c4ed4f0

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,42 @@
1-
## ClickHouse Connect
1+
## Timeplus Connect
22

3-
A high performance core database driver for connecting ClickHouse to Python, Pandas, and Superset
3+
This project provides Python connector to interact with Proton, the code is based on [clickhouse-connect](https://github.com/ClickHouse/clickhouse-connect)
4+
5+
A high performance core database driver for connecting Timeplus to Python, Pandas, and Superset
46

57
* Pandas DataFrames
68
* Numpy Arrays
79
* PyArrow Tables
810
* Superset Connector
911
* SQLAlchemy 1.3 and 1.4 (limited feature set)
1012

11-
ClickHouse Connect currently uses the ClickHouse HTTP interface for maximum compatibility.
13+
Timeplus Connect currently uses the Timeplus HTTP interface for maximum compatibility.
1214

1315
### Installation
1416

1517
```
16-
pip install clickhouse-connect
18+
pip install timeplus-connect
1719
```
1820

19-
ClickHouse Connect requires Python 3.8 or higher.
21+
Timeplus Connect requires Python 3.8 or higher.
2022

2123
### Superset Connectivity
2224

23-
ClickHouse Connect is fully integrated with Apache Superset. Previous versions of ClickHouse Connect utilized a
25+
Timeplus Connect is fully integrated with Apache Superset. Previous versions of Timeplus Connect utilized a
2426
dynamically loaded Superset Engine Spec, but as of Superset v2.1.0 the engine spec was incorporated into the main
2527
Apache Superset project and removed from clickhouse-connect in v0.6.0. If you have issues connecting to earlier
2628
versions of Superset, please use clickhouse-connect v0.5.25.
2729

2830
When creating a Superset Data Source, either use the provided connection dialog, or a SqlAlchemy DSN in the form
29-
`clickhousedb://{username}:{password}@{host}:{port}`.
31+
`timeplusdb://{username}:{password}@{host}:{port}`.
3032

3133
### SQLAlchemy Implementation
3234

33-
ClickHouse Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with
35+
Timeplus Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with
3436
Superset. It has only been tested against SQLAlchemy versions 1.3.x and 1.4.x, and is unlikely to work with more
3537
complex SQLAlchemy applications.
3638

3739
### Asyncio Support
3840

39-
ClickHouse Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment.
41+
Timeplus Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment.
4042
See the [run_async example](./examples/run_async.py) for more details.
41-
42-
### Complete Documentation
43-
44-
The documentation for ClickHouse Connect has moved to
45-
[ClickHouse Docs](https://clickhouse.com/docs/en/integrations/language-clients/python/intro)

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def run_setup(try_c: bool = True):
4545
setup(
4646
name='timeplus-connect',
4747
author='Timeplus Inc.',
48-
author_email='clients@clickhouse.com',
48+
author_email='eng@timeplus.com',
4949
keywords=['timeplus', 'superset', 'sqlalchemy', 'http', 'driver'],
5050
description='Timeplus Database Core Driver for Python, Pandas, and Superset',
5151
version=version,

0 commit comments

Comments
 (0)