Go to file
Kevin Froman f86932c9b7 updated readme and formatting 2019-03-01 11:10:51 -06:00
deadsimplekv updated readme and formatting 2019-03-01 11:10:51 -06:00
docs make sure docs is in main docs folder for gh pages 2019-03-01 10:54:43 -06:00
tests better commented tests to trigger build 2019-03-01 00:09:38 -06:00
.gitignore added documentation, docs and gitignore 2019-03-01 10:40:49 -06:00
.travis.yml added readme and change py version in travis 2019-03-01 00:16:52 -06:00
LICENSE implemented most logic and tests 2019-02-28 23:50:06 -06:00
Makefile make sure docs is in main docs folder for gh pages 2019-03-01 10:54:43 -06:00
README.md updated readme and formatting 2019-03-01 11:10:51 -06:00
run_tests.sh implemented most logic and tests 2019-02-28 23:50:06 -06:00
setup.py added documentation, docs and gitignore 2019-03-01 10:40:49 -06:00

README.md

DeadSimpleKV

Build Status

As the name implies, this is merely a simple key-value store for Python.

Not counting comments and tests, it is less than 100 lines of code.

It doesn't do anything crazy. It just takes json serializable data and stores it to disk.

You can control when and where to read/write, and that's it.

No bloat, only 3 public methods.

Usage

Install:

python3 setup.py install

Create the KV instance:

# If the file already exists, it will load the json data from it
kv = deadsimplekv.DeadSimpleKV('/path/to/file')

You can specify how often to refresh and flush to file by passing flush_seconds and refresh_seconds respectively.

Get and set values:

# Automatically reads/writes to disk every time unless no file was specified.
# Set flush_seconds or refresh_seconds to None to disable automatic read/write.
# Set them to >0 values to automatically read/write if time has elapsed. 
kv.put('my_key', True)
kv.get('my_key') # returns True.

Delete a key/value pair:

kv.delete('my_key')

Warning: Be sure to manually flush when destroying the kv instance (such as by exiting your program) to avoid losing data, as flushes only happen when .put has been called.