Skip to main content

Versioned key-value store with git-like commit, branch, and merge semantics.

Project description

kvgit 🔀

Git-style versioning for your data. Commits, branches, and merges -- backed by a dict-like MutableMapping.

Features Description
Dict interface MutableMapping[str, Any] -- reads and writes work like a dict
Commits Immutable, content-addressable snapshots with rollback
Branches Cheap forks with CAS-based optimistic concurrency
Three-way merge Auto-merges non-overlapping changes; pluggable merge fns for conflicts
Eviction High/low water rebase drops least-recently-used keys automatically
Pluggable backends In-memory, disk (diskcache), git (GitPython), IndexedDB (Pyodide/browser), or bring your own KVStore

Install

pip install kvgit            # in-memory only
pip install kvgit[disk]      # adds disk backend via diskcache
pip install kvgit[git]       # adds git backend via GitPython (requires git on PATH)
# IndexedDB backend is available automatically in Pyodide (browser) environments

Quick example

import kvgit

main = kvgit.store()

main["user"] = "alice"
main["score"] = 0
main.commit()

# Branch and diverge
dev = main.create_branch("dev")
dev["score"] = 999
dev.commit()

print(main["score"])  # 0   (main unchanged)
print(dev["score"])   # 999 (dev branch)

Part of the agex stack

kvgit provides versioned agent memory in agex with branching and rollback. It also works as a versioned backing store for monkeyfs virtual filesystems -- pass a Staged instance anywhere a dict is expected.

Development

uv sync --extra dev
uv run pytest

Documentation

See docs/ for detailed documentation:

  • Quick Start -- common patterns with runnable examples
  • API Reference -- full reference for all classes, methods, and types

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kvgit-0.2.1.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kvgit-0.2.1-py3-none-any.whl (46.8 kB view details)

Uploaded Python 3

File details

Details for the file kvgit-0.2.1.tar.gz.

File metadata

  • Download URL: kvgit-0.2.1.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for kvgit-0.2.1.tar.gz
Algorithm Hash digest
SHA256 00e157752fc1ae238d2826bd56e02131b9268ac66758a3d1b3a44a2d93a257de
MD5 14fe0ed21830cfeae4c7dde2ebf85e80
BLAKE2b-256 5822650458e8cf80c8dc05e7c0ace03af3750c90d0f9643850323b12c839f730

See more details on using hashes here.

File details

Details for the file kvgit-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: kvgit-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 46.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for kvgit-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef3b3157ce7540f4ece6231750d1cad1b5377236a9469a70394a85891ad8c0ad
MD5 c88ff66ec10e8e7fe3800ee2bf8af28d
BLAKE2b-256 40f452fd8f73a41543f959b2f3a2237185d11177a81e6339e46c82de3e724d26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page