mirror of
https://github.com/hanzo-ds/driver.git
synced 2026-10-30 20:32:40 +00:00
zeekay
073c1bf61e
The wire protocol was the last holdout and it was not cosmetic: the Hanzo Datastore server reads X-Datastore-User, and answers a request bearing X-ClickHouse-User with 401. Verified against the live server, both directions. So a client still sending the old headers is not merely off-brand, it cannot authenticate over HTTP. Everything else follows: types, dialects, error modules, docstrings and doc links now name Datastore, and doc URLs point at docs.hanzo.ai/datastore rather than the upstream vendor's site. Zero occurrences of the old name remain. Still cut from the pinned upstream version, so behaviour is unchanged.
104 lines
2.5 KiB
ReStructuredText
104 lines
2.5 KiB
ReStructuredText
.. _installation:
|
|
|
|
Installation
|
|
============
|
|
|
|
Python Version
|
|
--------------
|
|
|
|
Datastore-driver supports Python 3.7 and newer and PyPy.
|
|
|
|
Build Dependencies
|
|
------------------
|
|
|
|
Starting from version *0.1.0* for building from source `gcc`, python and linux headers are required.
|
|
|
|
Example for `python:alpine` docker image:
|
|
|
|
.. code-block:: bash
|
|
|
|
apk add gcc musl-dev
|
|
|
|
By default there are wheels for Linux, Mac OS X and Windows.
|
|
|
|
Packages for Linux and Mac OS X are available for python: 3.7 -- 3.12.
|
|
|
|
Packages for Windows are available for python: 3.7 -- 3.12.
|
|
|
|
Starting from version *0.2.3* there are wheels for musl-based Linux distributions.
|
|
|
|
Dependencies
|
|
------------
|
|
|
|
These distributions will be installed automatically when installing datastore-driver.
|
|
|
|
* `pytz`_ library for timezone calculations.
|
|
* `enum34`_ backported Python 3.4 Enum.
|
|
|
|
.. _pytz: http://pytz.sourceforge.net/
|
|
.. _enum34: https://pypi.org/project/enum34/
|
|
|
|
Optional dependencies
|
|
~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
These distributions will not be installed automatically. Datastore-driver will detect and
|
|
use them if you install them.
|
|
|
|
* `datastore-cityhash`_ provides CityHash algorithm of specific version, see :ref:`compression-cityhash-notes`.
|
|
* `lz4`_ enables `LZ4/LZ4HC compression <http://www.lz4.org/>`_ support.
|
|
* `zstd`_ enables `ZSTD compression <https://facebook.github.io/zstd/>`_ support.
|
|
|
|
.. _datastore-cityhash: https://pythonhosted.org/blinker/
|
|
.. _lz4: https://python-lz4.readthedocs.io/
|
|
.. _zstd: https://pypi.org/project/zstd/
|
|
|
|
|
|
.. _installation-pypi:
|
|
|
|
Installation from PyPI
|
|
----------------------
|
|
|
|
The package can be installed using ``pip``:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install datastore-driver
|
|
|
|
You can install extras packages if you need compression support. Example of
|
|
LZ4 compression requirements installation:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install datastore-driver[lz4]
|
|
|
|
You also can specify multiple extras by using comma.
|
|
Install LZ4 and ZSTD requirements:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install datastore-driver[lz4,zstd]
|
|
|
|
|
|
.. _installation-numpy-support:
|
|
|
|
NumPy support
|
|
-------------
|
|
|
|
You can install additional packages (NumPy and Pandas) if you need NumPy support:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install datastore-driver[numpy]
|
|
|
|
NumPy supported versions are limited by ``numpy`` package python support.
|
|
|
|
|
|
Installation from github
|
|
------------------------
|
|
|
|
Development version can be installed directly from github:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install git+https://github.com/mymarilyn/datastore-driver@master#egg=datastore-driver
|