cachify 0.2.0__tar.gz → 0.2.1__tar.gz

{cachify-0.2.0 → cachify-0.2.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Pulsar Finance
+Copyright (c) 2026 Pulsar Finance
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{cachify-0.2.0 → cachify-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cachify
-Version: 0.2.0
+Version: 0.2.1
 Summary: A simple cache library with sync/async support, Memory and Redis backend
 License: MIT
 License-File: LICENSE
@@ -28,6 +28,19 @@ Description-Content-Type: text/markdown
 
 A simple and robust caching library for Python functions, supporting both synchronous and asynchronous code.
 
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic Usage](#basic-usage)
+  - [Redis Cache](#redis-cache)
+  - [Never Die Cache](#never-die-cache)
+  - [Skip Cache](#skip-cache)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Features
 
 - Cache function results based on function ID and arguments
@@ -41,12 +54,14 @@ A simple and robust caching library for Python functions, supporting both synchr
 ## Installation
 
 ```bash
-# Clone the repository
-git clone https://github.com/PulsarDefi/cachify.git
-cd cachify
+# Using pip
+pip install cachify
+
+# Using poetry
+poetry add cachify
 
-# Install the package
-poetry install
+# Using uv
+uv add cachify
 ```
 
 ## Usage
@@ -57,18 +72,57 @@ poetry install
 from cachify import cache
 
 # Cache function in sync functions
-@cache(ttl=60) # ttl in seconds
+@cache(ttl=60)  # ttl in seconds
 def expensive_calculation(a, b):
     # Some expensive operation
     return a + b
 
 # And async functions
-@cache(ttl=3600) # ttl in seconds
+@cache(ttl=3600)  # ttl in seconds
 async def another_calculation(url):
     # Some expensive IO call
     return await httpx.get(url).json()
 ```
 
+### Decorator Parameters
+
+| Parameter        | Type              | Default | Description                                          |
+| ---------------- | ----------------- | ------- | ---------------------------------------------------- |
+| `ttl`            | `int \| float`    | `300`   | Time to live for cached items in seconds             |
+| `never_die`      | `bool`            | `False` | If True, cache refreshes automatically in background |
+| `cache_key_func` | `Callable`        | `None`  | Custom function to generate cache keys               |
+| `ignore_fields`  | `tuple[str, ...]` | `()`    | Function parameters to exclude from cache key        |
+
+### Custom Cache Key Function
+
+Use `cache_key_func` when you need custom control over how cache keys are generated:
+
+```python
+from cachify import cache
+
+def custom_key(args: tuple, kwargs: dict) -> str:
+    user_id = kwargs.get("user_id") or args[0]
+    return f"user:{user_id}"
+
+@cache(ttl=60, cache_key_func=custom_key)
+def get_user_profile(user_id: int):
+    return fetch_from_database(user_id)
+```
+
+### Ignore Fields
+
+Use `ignore_fields` to exclude specific parameters from the cache key. Useful when some arguments don't affect the result:
+
+```python
+from cachify import cache
+
+@cache(ttl=300, ignore_fields=("logger", "request_id"))
+def fetch_data(query: str, logger: Logger, request_id: str):
+    # Cache key only uses 'query', ignoring logger and request_id
+    logger.info(f"Fetching data for request {request_id}")
+    return database.execute(query)
+```
+
 ### Redis Cache
 
 For distributed caching across multiple processes or machines, use `rcache`:
@@ -80,7 +134,7 @@ from cachify import setup_redis_config, rcache
 # Configure Redis (call once at startup)
 setup_redis_config(
     sync_client=redis.from_url("redis://localhost:6379/0"),
-    key_prefix="myapp",       # default: "key_prefix", prefix searchable on redis "PREFIX:*"
+    key_prefix="myapp",       # default: "cachify", prefix searchable on redis "PREFIX:*"
     lock_timeout=10,          # default: 10, maximum lock lifetime in seconds
     on_error="silent",        # "silent" (default) or "raise" in case of redis errors
 )
@@ -95,7 +149,7 @@ import redis.asyncio as aredis
 setup_redis_config(async_client=aredis.from_url("redis://localhost:6379/0"))
 
 @rcache(ttl=300)
-def get_user_async(user_id: int) -> dict:
+async def get_user_async(user_id: int) -> dict:
     return await fetch_from_database(user_id)
 ```
 
@@ -166,7 +220,11 @@ Run the test scripts
 poetry run python -m pytest
 ```
 
+## Contributing
+
+Contributions are welcome! Feel free to open an issue or submit a pull request.
+
 ## License
 
-MIT
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/PulsarDataSolutions/cachify/blob/master/LICENSE) file for details.
 

{cachify-0.2.0 → cachify-0.2.1}/README.md

@@ -2,6 +2,19 @@
 
 A simple and robust caching library for Python functions, supporting both synchronous and asynchronous code.
 
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic Usage](#basic-usage)
+  - [Redis Cache](#redis-cache)
+  - [Never Die Cache](#never-die-cache)
+  - [Skip Cache](#skip-cache)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
 ## Features
 
 - Cache function results based on function ID and arguments
@@ -15,12 +28,14 @@ A simple and robust caching library for Python functions, supporting both synchr
 ## Installation
 
 ```bash
-# Clone the repository
-git clone https://github.com/PulsarDefi/cachify.git
-cd cachify
+# Using pip
+pip install cachify
+
+# Using poetry
+poetry add cachify
 
-# Install the package
-poetry install
+# Using uv
+uv add cachify
 ```
 
 ## Usage
@@ -31,18 +46,57 @@ poetry install
 from cachify import cache
 
 # Cache function in sync functions
-@cache(ttl=60) # ttl in seconds
+@cache(ttl=60)  # ttl in seconds
 def expensive_calculation(a, b):
     # Some expensive operation
     return a + b
 
 # And async functions
-@cache(ttl=3600) # ttl in seconds
+@cache(ttl=3600)  # ttl in seconds
 async def another_calculation(url):
     # Some expensive IO call
     return await httpx.get(url).json()
 ```
 
+### Decorator Parameters
+
+| Parameter        | Type              | Default | Description                                          |
+| ---------------- | ----------------- | ------- | ---------------------------------------------------- |
+| `ttl`            | `int \| float`    | `300`   | Time to live for cached items in seconds             |
+| `never_die`      | `bool`            | `False` | If True, cache refreshes automatically in background |
+| `cache_key_func` | `Callable`        | `None`  | Custom function to generate cache keys               |
+| `ignore_fields`  | `tuple[str, ...]` | `()`    | Function parameters to exclude from cache key        |
+
+### Custom Cache Key Function
+
+Use `cache_key_func` when you need custom control over how cache keys are generated:
+
+```python
+from cachify import cache
+
+def custom_key(args: tuple, kwargs: dict) -> str:
+    user_id = kwargs.get("user_id") or args[0]
+    return f"user:{user_id}"
+
+@cache(ttl=60, cache_key_func=custom_key)
+def get_user_profile(user_id: int):
+    return fetch_from_database(user_id)
+```
+
+### Ignore Fields
+
+Use `ignore_fields` to exclude specific parameters from the cache key. Useful when some arguments don't affect the result:
+
+```python
+from cachify import cache
+
+@cache(ttl=300, ignore_fields=("logger", "request_id"))
+def fetch_data(query: str, logger: Logger, request_id: str):
+    # Cache key only uses 'query', ignoring logger and request_id
+    logger.info(f"Fetching data for request {request_id}")
+    return database.execute(query)
+```
+
 ### Redis Cache
 
 For distributed caching across multiple processes or machines, use `rcache`:
@@ -54,7 +108,7 @@ from cachify import setup_redis_config, rcache
 # Configure Redis (call once at startup)
 setup_redis_config(
     sync_client=redis.from_url("redis://localhost:6379/0"),
-    key_prefix="myapp",       # default: "key_prefix", prefix searchable on redis "PREFIX:*"
+    key_prefix="myapp",       # default: "cachify", prefix searchable on redis "PREFIX:*"
     lock_timeout=10,          # default: 10, maximum lock lifetime in seconds
     on_error="silent",        # "silent" (default) or "raise" in case of redis errors
 )
@@ -69,7 +123,7 @@ import redis.asyncio as aredis
 setup_redis_config(async_client=aredis.from_url("redis://localhost:6379/0"))
 
 @rcache(ttl=300)
-def get_user_async(user_id: int) -> dict:
+async def get_user_async(user_id: int) -> dict:
     return await fetch_from_database(user_id)
 ```
 
@@ -140,6 +194,10 @@ Run the test scripts
 poetry run python -m pytest
 ```
 
+## Contributing
+
+Contributions are welcome! Feel free to open an issue or submit a pull request.
+
 ## License
 
-MIT
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/PulsarDataSolutions/cachify/blob/master/LICENSE) file for details.

{cachify-0.2.0 → cachify-0.2.1}/cachify/__init__.py

@@ -20,5 +20,4 @@ __all__ = [
     "reset_redis_config",
     "DEFAULT_KEY_PREFIX",
     "CacheKwargs",
-    "clear_never_die_registry",
 ]

{cachify-0.2.0 → cachify-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cachify"
-version = "0.2.0"
+version = "0.2.1"
 description = "A simple cache library with sync/async support, Memory and Redis backend"
 license = "MIT"
 readme = "README.md"