==============
k2hash_python
==============
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://github.com/yahoojapan/k2hash_python/blob/master/LICENSE
.. image:: https://img.shields.io/pypi/pyversions/k2hash.svg
:target: https://pypi.python.org/pypi/k2hash
.. image:: https://img.shields.io/github/forks/yahoojapan/k2hash_python.svg
:target: https://github.com/yahoojapan/k2hash_python/network
.. image:: https://img.shields.io/github/stars/yahoojapan/k2hash_python.svg
:target: https://github.com/yahoojapan/k2hash_python/stargazers
.. image:: https://img.shields.io/github/issues/yahoojapan/k2hash_python.svg
:target: https://github.com/yahoojapan/k2hash_python/issues
.. image:: https://github.com/yahoojapan/k2hash_python/workflows/Python%20package/badge.svg
:target: https://github.com/yahoojapan/k2hash_python/actions
.. image:: https://readthedocs.org/projects/k2hash-python/badge/?version=latest
:target: https://k2hash-python.readthedocs.io/en/latest/?badge=latest
.. image:: https://img.shields.io/pypi/v/k2hash
:target: https://pypi.org/project/k2hash/
Overview
---------
k2hash_python is an official python driver for `k2hash`_.
.. _`k2hash`: https://k2hash.antpick.ax/
.. image:: https://raw.githubusercontent.com/yahoojapan/k2hash_python/main/docs/images/top_k2hash_python.png
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/
.. _`ドキュメントトップ`: https://k2hash-python.readthedocs.io/
.. _`About K2HASH`: https://k2hash.antpick.ax/
.. _`K2HASHについて`: https://k2hash.antpick.ax/
.. _`About AntPickax`: https://antpick.ax
.. _`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/
Raw data
{
"_id": null,
"home_page": "https://github.com/yahoojapan/k2hash_python",
"name": "k2hash",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Hirotaka Wakabayashi",
"author_email": "hiwakaba@yahoo-corp.jp",
"download_url": "https://files.pythonhosted.org/packages/61/71/c8156660e8c3101b680e6b53d19b2c8289678265ca769b6f31fae96aa5d0/k2hash-1.0.1.tar.gz",
"platform": null,
"description": "==============\nk2hash_python\n==============\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: https://github.com/yahoojapan/k2hash_python/blob/master/LICENSE\n.. image:: https://img.shields.io/pypi/pyversions/k2hash.svg\n :target: https://pypi.python.org/pypi/k2hash\n.. image:: https://img.shields.io/github/forks/yahoojapan/k2hash_python.svg\n :target: https://github.com/yahoojapan/k2hash_python/network\n.. image:: https://img.shields.io/github/stars/yahoojapan/k2hash_python.svg\n :target: https://github.com/yahoojapan/k2hash_python/stargazers\n.. image:: https://img.shields.io/github/issues/yahoojapan/k2hash_python.svg\n :target: https://github.com/yahoojapan/k2hash_python/issues\n.. image:: https://github.com/yahoojapan/k2hash_python/workflows/Python%20package/badge.svg\n :target: https://github.com/yahoojapan/k2hash_python/actions\n.. image:: https://readthedocs.org/projects/k2hash-python/badge/?version=latest\n :target: https://k2hash-python.readthedocs.io/en/latest/?badge=latest\n.. image:: https://img.shields.io/pypi/v/k2hash\n :target: https://pypi.org/project/k2hash/\n \nOverview\n---------\n\nk2hash_python is an official python driver for `k2hash`_.\n\n.. _`k2hash`: https://k2hash.antpick.ax/\n\n.. image:: https://raw.githubusercontent.com/yahoojapan/k2hash_python/main/docs/images/top_k2hash_python.png\n\n\nInstall\n--------\n\nFirstly you must install the k2hash shared library::\n\n curl -o- https://raw.github.com/yahoojapan/k2hash_python/master/utils/libk2hash.sh | bash\n\nThen, let's install k2hash using pip::\n\n pip install k2hash\n\n\nUsage\n------\n\nTry to set a key and get it::\n\n import k2hash\n \n k = k2hash.K2hash('test.k2h')\n k.set('hello', 'world')\n v = k.get('hello')\n print(v) // world\n\n\nDevelopment\n------------\n\nClone this repository and go into the directory, then run the following command::\n\n $ python3 -m pip install --upgrade build\n $ python3 -m build\n\n\nDocuments\n----------\n\nHere are documents including other components.\n\n`Document top page`_\n\n`About K2HASH`_\n\n`About AntPickax`_\n\n.. _`Document top page`: https://k2hash-python.readthedocs.io/\n.. _`\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u30c8\u30c3\u30d7`: https://k2hash-python.readthedocs.io/\n.. _`About K2HASH`: https://k2hash.antpick.ax/\n.. _`K2HASH\u306b\u3064\u3044\u3066`: https://k2hash.antpick.ax/\n.. _`About AntPickax`: https://antpick.ax\n.. _`AntPickax\u306b\u3064\u3044\u3066`: https://antpick.ax\n\n\nPackages\n--------\n\nHere are packages including other components.\n\n`k2hash(python packages)`_\n\n.. _`k2hash(python packages)`: https://pypi.org/project/k2hash/\n\n\nLicense\n--------\n\nMIT License. See the LICENSE file.\n\nAntPickax\n---------\n\n**k2hash_python** is a project by AntPickax_, which is an open source team in `Yahoo Japan Corporation`_.\n\n.. _AntPickax: https://antpick.ax/\n.. _`Yahoo Japan Corporation`: https://about.yahoo.co.jp/info/en/company/\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A module for k2hash from antpickax",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/yahoojapan/k2hash_python/issues",
"Homepage": "https://github.com/yahoojapan/k2hash_python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c6fcdd662a475283cb7f98f8bfaba2d8a49db60c77047d810bf4f19282403f5",
"md5": "a531fb0dc726fcb02aec91b9d556bce7",
"sha256": "8dbf1f511dd13afb9909a12eb7be4be563557a3cb600fe82b2b8f0b2ef8d31c6"
},
"downloads": -1,
"filename": "k2hash-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a531fb0dc726fcb02aec91b9d556bce7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17543,
"upload_time": "2023-10-02T07:41:13",
"upload_time_iso_8601": "2023-10-02T07:41:13.754094Z",
"url": "https://files.pythonhosted.org/packages/3c/6f/cdd662a475283cb7f98f8bfaba2d8a49db60c77047d810bf4f19282403f5/k2hash-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6171c8156660e8c3101b680e6b53d19b2c8289678265ca769b6f31fae96aa5d0",
"md5": "307217cb51d1a33423cca12bfc830b49",
"sha256": "bdbe16f046c12c775e65a2107c290d13a51106771a9b71982cd7346e588be07b"
},
"downloads": -1,
"filename": "k2hash-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "307217cb51d1a33423cca12bfc830b49",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 280898,
"upload_time": "2023-10-02T07:41:16",
"upload_time_iso_8601": "2023-10-02T07:41:16.292728Z",
"url": "https://files.pythonhosted.org/packages/61/71/c8156660e8c3101b680e6b53d19b2c8289678265ca769b6f31fae96aa5d0/k2hash-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-02 07:41:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yahoojapan",
"github_project": "k2hash_python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "k2hash"
}
JSON
