python-flowmaticcache

A small cache abstraction for Python, with pluggable backends: Redis, Valkey, Memcached, flowmaticdb and an in-process shared-memory store.

Install

pip install flowmaticcache                 # shared_memory works out of the box
pip install "flowmaticcache[redis]"        # Redis
pip install "flowmaticcache[valkey]"       # Valkey
pip install "flowmaticcache[memcached]"    # Memcached
pip install "flowmaticcache[flowmaticdb]"  # flowmaticdb-backed cache table
pip install "flowmaticcache[all]"          # every backend
pip install "flowmaticcache[dev]"          # pytest, mypy, ruff + all backends

Usage

from flowmaticcache import Cache

cache = Cache.shared_memory()
# cache = Cache.connect_redis(host="localhost", port=6379)
# cache = Cache.connect_valkey(host="localhost", port=6380)
# cache = Cache.connect_memcached(host="localhost", port=11211)
# cache = Cache.connect_flowmaticdb(db, table="cache")

cache.set("key", {"any": "picklable value"}, ttl=60)  # ttl in seconds, optional
cache.get("key")
cache.exists("key")
cache.delete("key")
cache.clear()

cache.add("key", "value", ttl=60)          # only sets if not already present, returns bool
cache.pull("key", default=None)            # get then delete
cache.remember("key", lambda: expensive(), ttl=60)  # get, or compute + store if missing/expired

Testing

Redis, Valkey and Memcached tests run against local containers:

docker compose up -d
pip install -e ".[dev]"
pytest

Database-backed tests use flowmaticdb's in-memory SQLite adapter, so no external service is required for those.

Publishing

./build-and-publish.sh

Reads PYPI_API_KEY from .env (see .env.example), builds the package and uploads it to PyPI after confirmation.