Init repo

Author: ptran1203

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+*.pyc
+test*.py

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Phat Tran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,48 @@
+# Redis cache for Python
+
+- Simple python redis cache library, mostly used as distributed caching, where application servers is in separated processes such as Gunicorn workers, K8s replicas.
+- **Asyncio Support for FastAPI, Starlette**
+
+## Requirements
+
+- Redis 5+
+- Python 3.6+
+
+## Installation
+
+```bash
+$ pip install py-redis-cache
+```
+
+## Simple usage
+
+```python
+from py_redis_cache import RedisCache
+
+# init redis_cache instance and connection
+redis_cache = RedisCache(
+    host="127.0.0.1",
+    port=6379,
+    verbose=1  # Turn on logging for demonstration, set to 0 for silent caching
+)
+
+@redis_cache.cache(ttl=10)  # Expire after 10 seconds
+def heavy_compute(a: list, b: list):
+    length = max(len(a), len(b))
+    c = [[]] * length
+    for i in range(length):
+        c[i] = a[i] * b[i]
+    return c
+
+result =  heavy_compute([1, 2, 3], [4, 5, 6])
+print(result)
+# Cache added, key=redis_cache::11=__main__.heavy_compute(a=[1, 2, 3].b=[4, 5, 6]), size=0.000Kb
+# [4, 10, 18]
+
+result =  heavy_compute([1, 2, 3], [4, 5, 6])
+print(result)
+# Cache hit, key=redis_cache::11=__main__.heavy_compute(a=[1, 2, 3].b=[4, 5, 6])
+# [4, 10, 18]
+```
+
+for further examples and use cases please visit [examples](examples)

examples/basic.py

@@ -0,0 +1,30 @@
+import sys
+sys.path.append(".")
+
+from py_redis_cache import RedisCache
+from py_redis_cache.functional import cache
+
+# init redis_cache instance and connection
+redis_cache = RedisCache(
+    host="127.0.0.1",
+    port=6379,
+    verbose=1  # Turn on logging for demonstration, set to 0 for silent caching
+)
+
+@redis_cache.cache(ttl=10)  # Expire after 10 seconds
+def heavy_compute(a: list, b: list):
+    length = max(len(a), len(b))
+    c = [[]] * length
+    for i in range(length):
+        c[i] = a[i] * b[i]
+    return c
+
+result =  heavy_compute([1, 2, 3], [4, 5, 6])
+print(result)
+# Cache added, key=redis_cache::11=__main__.heavy_compute(a=[1, 2, 3].b=[4, 5, 6]), size=0.000Kb
+# [4, 10, 18]
+
+result =  heavy_compute([1, 2, 3], [4, 5, 6])
+print(result)
+# Cache hit, key=redis_cache::11=__main__.heavy_compute(a=[1, 2, 3].b=[4, 5, 6])
+# [4, 10, 18]