METADATA 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. Metadata-Version: 2.1
  2. Name: clickhouse-connect
  3. Version: 0.7.3
  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. Requires-Python: ~=3.8
  19. Description-Content-Type: text/markdown
  20. License-File: LICENSE
  21. Requires-Dist: certifi
  22. Requires-Dist: urllib3 >=1.26
  23. Requires-Dist: pytz
  24. Requires-Dist: zstandard
  25. Requires-Dist: lz4
  26. Provides-Extra: arrow
  27. Requires-Dist: pyarrow ; extra == 'arrow'
  28. Provides-Extra: numpy
  29. Requires-Dist: numpy ; extra == 'numpy'
  30. Provides-Extra: orjson
  31. Requires-Dist: orjson ; extra == 'orjson'
  32. Provides-Extra: pandas
  33. Requires-Dist: pandas ; extra == 'pandas'
  34. Provides-Extra: sqlalchemy
  35. Requires-Dist: sqlalchemy <2.0,>1.3.21 ; extra == 'sqlalchemy'
  36. ## ClickHouse Connect
  37. A high performance core database driver for connecting ClickHouse to Python, Pandas, and Superset
  38. * Pandas DataFrames
  39. * Numpy Arrays
  40. * PyArrow Tables
  41. * Superset Connector
  42. * SQLAlchemy 1.3 and 1.4 (limited feature set)
  43. ClickHouse Connect currently uses the ClickHouse HTTP interface for maximum compatibility.
  44. ### Installation
  45. ```
  46. pip install clickhouse-connect
  47. ```
  48. ClickHouse Connect requires Python 3.8 or higher.
  49. ### Superset Connectivity
  50. ClickHouse Connect is fully integrated with Apache Superset. Previous versions of ClickHouse Connect utilized a
  51. dynamically loaded Superset Engine Spec, but as of Superset v2.1.0 the engine spec was incorporated into the main
  52. Apache Superset project and removed from clickhouse-connect in v0.6.0. If you have issues connecting to earlier
  53. versions of Superset, please use clickhouse-connect v0.5.25.
  54. When creating a Superset Data Source, either use the provided connection dialog, or a SqlAlchemy DSN in the form
  55. `clickhousedb://{username}:{password}@{host}:{port}`.
  56. ### SQLAlchemy Implementation
  57. ClickHouse Connect incorporates a minimal SQLAlchemy implementation (without any ORM features) for compatibility with
  58. Superset. It has only been tested against SQLAlchemy versions 1.3.x and 1.4.x, and is unlikely to work with more
  59. complex SQLAlchemy applications.
  60. ### Complete Documentation
  61. The documentation for ClickHouse Connect has moved to
  62. [ClickHouse Docs](https://clickhouse.com/docs/en/integrations/language-clients/python/intro)