Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

BuildBadge C++ PythonVersions PythonImpl PythonFormat PyPIVersion

Keyvi

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. 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. The index can be used as embedded key value store, e.g. if you already have a network stack in your application. A out of the box network enabled store is available with keyvi-server.

Introduction

Install

Quick

Precompiled binary wheels are available for OS X and Linux on PyPi. To install use:

pip install keyvi

From Source

The core part is a C++ header-only library, which can be used stand-alone. For more information check the Readme file in the keyvi subfolder.

The python extension can be compiled standalone, check the Readme file in the python subfolder for more information.

Usage

Internals

If you like to go deep down in the basics, keyvi is inspired by the following 2 papers:

Release procedure

License

keyvi is licensed under Apache License 2.0("ALv2"), see license for details, all 3rdparty libraries ship with their own license. Except Boost, Snappy and zlib all 3rdparty code can be exclusively found in the 3rdparty folder. The following licenses are used for the 3rdparty code (last updated: 0.5.0, provided without warranty).

C++ dependencies

Dependency License
Boost Boost Software License
moodycamel::ConcurrentQueue Simplified BSD License
md5 RSA MD5 License
msgpack-c Boost Software License
RapidJSON MIT License
Snappy BSD
tiny-process-library MIT License
Zlib Zlib License

Python dependencies

The python version ships with the same 3rdparty dependencies as the C++ code and additionaly depends on:

Dependency License
msgpack (for python) Apache License, Version 2.0

Credits

Thanks go to:

About

Keyvi - the key value index. It is an in-memory FST-based data structure highly optimized for size and lookup performance.

Topics

Resources

License

Code of conduct

Packages

No packages published