Metadata-Version: 2.1
Name: k2hash
Version: 1.0.0
Summary: A module for k2hash from antpickax
Home-page: https://github.com/yahoojapan/k2hash_python
Author: Hirotaka Wakabayashi
Author-email: hiwakaba@yahoo-corp.jp
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/yahoojapan/k2hash_python/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE

==============
k2hash_python
==============

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
        :target: https://github.com/yahoojapan/k2hash_python/blob/master/LICENSE

Overview
---------

k2hash_python is an official python driver for `k2hash`_.

.. _`k2hash`: https://k2hash.antpick.ax/


Install
--------

Firstly you must install the k2hash shared library::

    curl -o- https://raw.github.com/yahoojapan/k2hash_python/master/utils/libk2hash.sh | bash

Then, let's install k2hash using pip::

    pip install k2hash


Usage
------

Try to set a key and get it::

    import k2hash
    
    k = k2hash.K2hash('test.k2h')
    k.set('hello', 'world')
    v = k.get('hello')
    print(v)    // world


Development
------------

Clone this repository and go into the directory, then run the following command::

    $ python3 -m pip install --upgrade build
    $ python3 -m build


Documents
----------

Here are documents including other components.

`Document top page`_

`About K2HASH`_

`About AntPickax`_

.. _`Document top page`: https://k2hash-python.readthedocs.io/
.. _`About K2HASH`: https://k2hash.antpick.ax/
.. _`About AntPickax`: https://antpick.ax


Packages
--------

Here are packages including other components.

`k2hash(python packages)`_

.. _`k2hash(python packages)`:  https://pypi.org/project/k2hash/


License
--------

MIT License. See the LICENSE file.

AntPickax
---------

**k2hash_python** is a project by AntPickax_, which is an open source team in `Yahoo Japan Corporation`_.

.. _AntPickax: https://antpick.ax/
.. _`Yahoo Japan Corporation`: https://about.yahoo.co.jp/info/en/company/



