Installation

You can install kms with pip:

pip install key-multivalue-storage

Or, install it with uv:

uv add key-multivalue-storage

You can also install the dev extra. This extra provides Pylint on the side, allowing for easier development and testing.

pip install key-multivalue-storage[dev]

Warning

This extra is only available on versions later than kms-v1.2.2/2026.05.06b.

Note

From kms-semver1.3.0 onwards, this extra will also include griffe and kms-testing.

Tip

No pip or uv? Install the wheel here: https://pypi.org/project/key-multivalue-storage/#files

Basic Usage

Tip

When importing just logic related to Storage (i.e. Storage, Load, Edit, Delete), the recommended import statement is:

from key_multivalue_storage import Storage # note the module name!

Otherwise, the main recommended import statement stands as:

import key_multivalue_storage as kms # note the module name!

Create a Storage object to prepare the data to be stored:

from key_multivalue_storage import Storage # note the module name!
my-db = Storage("my_top_level_key", mysubkey="myvalue", myothersk="anotherval")

To store the object, use Storage.store().
```
my-db.store("database.json")
```
Load data from a JSON file back into a Storage object:
```
my-db = Storage.Load.by_key("my_top_level_key")
print(my-db)
```
Output: ```json { “my_top_level_key”: { “mysubkey”: “myvalue”, “myothersk”: “anotherval” } }
Change global settings:
```
Storage.indent = 4 #indent size of JSON files
Storage.encode = True # Whether to encode stored values
Storage.auto_delete_self = True
# Whether to automatically release the object
# from memory after certain operations
```
Main Classes

Storage

The Storage class is the main class in this library, in which all operations revolve around. It is (so far) the only class in the library that can be instantiated.

Parameters

Constants

Methods

Regular Methods

Storage.store(file_path: str)

Special Methods

Usage

Other Info

Storage.Load

Methods

Storage.Load.by_key(file_path: str, top_lv_key: Any)

Usage

Other Info

Storage.Edit

Methods

Usage

Other Info

Storage.Delete

Methods

Usage

Other Info

Custom Warnings and Exceptions

Warning

In kms-semver1.3.0, these warnings and exceptions will no longer fall under kms.Storage but rather just kms.