Metadata-Version: 2.2
Name: timeplus-connect
Version: 0.8.14
Summary: Timeplus Database Core Driver for Python, Pandas, and Superset
Home-page: https://github.com/timeplus-io/timeplus-connect
Author: Timeplus Inc.
Author-email: eng@timeplus.com
License: Apache License 2.0
Keywords: timeplus,superset,sqlalchemy,http,driver
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi
Requires-Dist: urllib3>=1.26
Requires-Dist: pytz
Requires-Dist: zstandard
Requires-Dist: lz4
Provides-Extra: sqlalchemy
Requires-Dist: sqlalchemy<2.0,>1.3.21; extra == "sqlalchemy"
Provides-Extra: numpy
Requires-Dist: numpy; extra == "numpy"
Provides-Extra: pandas
Requires-Dist: pandas; extra == "pandas"
Provides-Extra: arrow
Requires-Dist: pyarrow; extra == "arrow"
Provides-Extra: orjson
Requires-Dist: orjson; extra == "orjson"
Provides-Extra: tzlocal
Requires-Dist: tzlocal>=4.0; extra == "tzlocal"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

## Timeplus Connect

This project provides Python connector to interact with Timeplus Enterprise or Timeplus Proton. The code is based on [clickhouse-connect](https://github.com/ClickHouse/clickhouse-connect).

A high performance database driver for connecting Timeplus to Python, Pandas, and Superset

* Pandas DataFrames
* Numpy Arrays
* PyArrow Tables
* Superset Connector
* SQLAlchemy 1.3 and 1.4 (limited feature set)

Timeplus Connect currently uses the Timeplus HTTP interface for maximum compatibility.

### Installation

```
pip install timeplus-connect
```

Timeplus Connect requires Python 3.8 or higher.

### Superset Connectivity (to be verified)

Timeplus Connect is fully integrated with Apache Superset.

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

### SQLAlchemy Implementation (to be verified)

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

### Asyncio Support (to be verified)

Timeplus Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment.
See the [run_async example](./examples/run_async.py) for more details.
