METADATA 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. Metadata-Version: 2.1
  2. Name: clickhouse-connect
  3. Version: 0.8.10
  4. Summary: ClickHouse Database Core Driver for Python, Pandas, and Superset
  5. Home-page: https://github.com/ClickHouse/clickhouse-connect
  6. Author: ClickHouse Inc.
  7. Author-email: clients@clickhouse.com
  8. License: Apache License 2.0
  9. Keywords: clickhouse,superset,sqlalchemy,http,driver
  10. Classifier: Development Status :: 4 - Beta
  11. Classifier: Intended Audience :: Developers
  12. Classifier: License :: OSI Approved :: Apache Software License
  13. Classifier: Programming Language :: Python :: 3.8
  14. Classifier: Programming Language :: Python :: 3.9
  15. Classifier: Programming Language :: Python :: 3.10
  16. Classifier: Programming Language :: Python :: 3.11
  17. Classifier: Programming Language :: Python :: 3.12
  18. Classifier: Programming Language :: Python :: 3.13
  19. Requires-Python: ~=3.8
  20. Description-Content-Type: text/markdown
  21. License-File: LICENSE
  22. Requires-Dist: certifi
  23. Requires-Dist: urllib3>=1.26
  24. Requires-Dist: pytz
  25. Requires-Dist: zstandard
  26. Requires-Dist: lz4
  27. Provides-Extra: sqlalchemy
  28. Requires-Dist: sqlalchemy<2.0,>1.3.21; extra == "sqlalchemy"
  29. Provides-Extra: numpy
  30. Requires-Dist: numpy; extra == "numpy"
  31. Provides-Extra: pandas
  32. Requires-Dist: pandas; extra == "pandas"
  33. Provides-Extra: arrow
  34. Requires-Dist: pyarrow; extra == "arrow"
  35. Provides-Extra: orjson
  36. Requires-Dist: orjson; extra == "orjson"
  37. Provides-Extra: tzlocal
  38. Requires-Dist: tzlocal>=4.0; extra == "tzlocal"
  39. ## ClickHouse Connect
  40. A high performance core database driver for connecting ClickHouse to Python, Pandas, and Superset
  41. * Pandas DataFrames
  42. * Numpy Arrays
  43. * PyArrow Tables
  44. * Superset Connector
  45. * SQLAlchemy 1.3 and 1.4 (limited feature set)
  46. ClickHouse Connect currently uses the ClickHouse HTTP interface for maximum compatibility.
  47. ### Installation
  48. ```
  49. pip install clickhouse-connect
  50. ```
  51. ClickHouse Connect requires Python 3.8 or higher.
  52. ### Superset Connectivity
  53. ClickHouse Connect is fully integrated with Apache Superset. Previous versions of ClickHouse Connect utilized a
  54. dynamically loaded Superset Engine Spec, but as of Superset v2.1.0 the engine spec was incorporated into the main
  55. Apache Superset project and removed from clickhouse-connect in v0.6.0. If you have issues connecting to earlier
  56. versions of Superset, please use clickhouse-connect v0.5.25.
  57. When creating a Superset Data Source, either use the provided connection dialog, or a SqlAlchemy DSN in the form
  58. `clickhousedb://{username}:{password}@{host}:{port}`.
  59. ### SQLAlchemy Implementation
  60. ClickHouse Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with
  61. Superset. It has only been tested against SQLAlchemy versions 1.3.x and 1.4.x, and is unlikely to work with more
  62. complex SQLAlchemy applications.
  63. ### Asyncio Support
  64. ClickHouse Connect provides an async wrapper, so that it is possible to use the client in an `asyncio` environment.
  65. See the [run_async example](./examples/run_async.py) for more details.
  66. ### Complete Documentation
  67. The documentation for ClickHouse Connect has moved to
  68. [ClickHouse Docs](https://clickhouse.com/docs/en/integrations/language-clients/python/intro)