Metadata-Version: 2.4
Name: keyvi
Version: 0.9.8b1
Summary: Python package for keyvi
Keywords: FST
Author-Email: Hendrik Muhs <hendrik.muhs@gmail.com>
License-Expression: Apache-2.0
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Project-URL: Homepage, http://keyvi.org
Project-URL: Repository, https://github.com/KeyviDev/keyvi
Project-URL: Documentation, https://keyvidev.github.io/keyvi/index.html
Requires-Python: >=3.10
Requires-Dist: msgpack>=1.0.0
Description-Content-Type: text/markdown

Keyvi - the short form for "Key value index" is a key value store (KVS) optimized for size and lookup speed. The usage of shared memory makes it scalable and resistant. The biggest difference to other stores is the underlying data structure based on [finite state machine](https://en.wikipedia.org/wiki/Finite-state_machine). Storage is very space efficient, fast and by design makes various sorts of approximate matching be it fuzzy string matching or geo highly efficient. The immutable FST data structure can be used stand-alone for static datasets. If you need online writes, you can use keyvi index, a _near realtime index_.

## Quick Start

Install keyvi with

```
pip3 install keyvi
```

create your first very simple index:

```
import keyvi.index
index = keyvi.index.Index("test-index")

index.Set('key', '{"answer": 42, "condition": "always"}')
index.Flush()
# get the entry for key
m = index.Get('key')
print(m.value)

# match fuzzy(levenshtein distance) with max edit distance 1, exact prefix 2
matches = index.GetFuzzy("kei", 1, 2)
print([m.matched_string for m in matches])
```

For more information visit the [docs](https://keyvidev.github.io/keyvi/index.html) and [project](http://keyvi.org) pages.
