NATS Key-Value

A Python client for the NATS Key-Value store, built on JetStream.

Features

• Create, update, and delete buckets
• Put, get, create, update, delete, and purge keys
• Optimistic concurrency via revisions
• Per-key history
• Per-key TTL
• Watch for changes with key pattern filters
• List keys and bucket statuses

Installation

pip install nats-key-value

Requires Python 3.13+ and a NATS server with JetStream enabled.

Usage

import asyncio
from nats.client import connect
from nats.jetstream import new as new_jetstream
from nats.key_value import KeyValueConfig, create_or_update_key_value

async def main():
    client = await connect("nats://localhost:4222")
    js = new_jetstream(client)

    kv = await create_or_update_key_value(js, KeyValueConfig(bucket="config"))

    await kv.put("greeting", b"Hello World!")

    entry = await kv.get("greeting")
    print(f"{entry.key} = {entry.value.decode()} (revision {entry.revision})")

    await kv.delete("greeting")

    await client.close()

if __name__ == "__main__":
    asyncio.run(main())

License

MIT

Contributing

Contributions welcome. Submit a Pull Request on GitHub.