iot-lru-cache

This package is an implementation of a Least Recently Used (LRU) caching algorithm for optimized caching on an IoT edge device.

Official Documentation | Source code | Package PyPI

Table of Contents

• Versioning
• Getting Started
  • Prerequisites
  • Basic Examples

Versioning

This repository adheres to Semantic Versioning. It will be maintained through the CHANGELOG.md and in GitHub Releases. It's important to note that you must maintain the version with your releases in iot/lru/cache/_version.py, otherwise a new package version will fail to get published.

Getting Started

This section provides basic examples with the iot-lru-cache.

Prerequisites

• Python 3.7 or later is required to use this package.

Basic Examples

1. Install via pip:

pip install iot-lru-cache

2. Import and say hello:

from iot.lru.cache import __version__

print(f"hello world from iot-lru-cache version: {__version__}")

3. Basic usage:

from iot.lru.cache import IoTLRUCache

# instantiate cache
cache = IoTLRUCache(capacity=100)

# print info w/ repr
print(f"{cache.__repr__()}")

# add a key-value pair to the cache
cache.put(key="my_key", value={"my": "value"})

# retrieve the value for a given key (returns -1 if not found)
val = cache.get(key="my_key")