Metadata-Version: 2.1
Name: clickhouse-connect
Version: 0.6.0
Summary: ClickHouse Database Core Driver
Home-page: https://github.com/ClickHouse/clickhouse-connect
Author: ClickHouse Inc.
Author-email: clients@clickhouse.com
License: Apache License 2.0
Keywords: clickhouse,superset,sqlalchemy,http,driver
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: ~=3.7
Description-Content-Type: text/markdown
Provides-Extra: arrow
Provides-Extra: numpy
Provides-Extra: orjson
Provides-Extra: pandas
Provides-Extra: sqlalchemy
License-File: LICENSE

## ClickHouse Connect

A high performance core database driver for connecting ClickHouse to Python
* Pandas DataFrames
* Numpy Arrays
* PyArrow Tables
* SQLAlchemy 1.3 and 1.4 (limited feature set)

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


### Installation

```
pip install clickhouse-connect
```

ClickHouse Connect requires Python 3.7 or higher. 


### Warning -- ZStd errors with versions 0.5.21 and below
Versions prior to 0.5.22 are not compatible with urllib3 version 2+ when using zstd compression.  If you encounter
such errors please upgrade to clickhouse-connect 0.5.22+ or downgrade your urllib3 version to 1.x


### Superset Compatibility
Starting with v0.6.0, clickhouse-connect no longer includes a Superset EngineSpec.  Instead, the relevant EngineSpec
has been moved to the core Apache Superset project as of Superset v2.1.0.  If you have issues connecting to earlier
versions of Superset, please use clickhouse-connect v0.5.25.


### SQLAlchemy Implementation
ClickHouse 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.


### Complete Documentation
The documentation for ClickHouse Connect has moved to
[ClickHouse Docs](https://clickhouse.com/docs/en/integrations/language-clients/python/intro) 


 


