rediskit 0.0.1__tar.gz

rediskit-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rediskit-0.0.1/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: rediskit
+Version: 0.0.1
+Summary: A comprehensive Redis toolkit for Python with caching, memoization, and utilities
+Author-email: Badr Elfarri <badr.elfarri@gmail.com>
+Maintainer-email: Badr Elfarri <badr.elfarri@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/badrelfarri/rediskit
+Project-URL: Documentation, https://github.com/badrelfarri/rediskit#readme
+Project-URL: Repository, https://github.com/badrelfarri/rediskit
+Project-URL: Bug Tracker, https://github.com/badrelfarri/rediskit/issues
+Project-URL: Changelog, https://github.com/badrelfarri/rediskit/blob/main/CHANGELOG.md
+Keywords: redis,cache,memoization,toolkit,async
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic
+Requires-Dist: cryptography
+Requires-Dist: redis
+Requires-Dist: polars
+Requires-Dist: python-redis-lock
+Requires-Dist: zstd
+Requires-Dist: pynacl
+Requires-Dist: dockerbuildsystem>=1.1.64
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: types-redis; extra == "dev"
+Requires-Dist: types-zstd; extra == "dev"
+Provides-Extra: docker
+Requires-Dist: dockerbuildsystem>=1.1.64; extra == "docker"
+Dynamic: license-file
+
+# rediskit
+
+A Python toolkit that provides Redis-backed performance and concurrency primitives for applications. It enables developers to add caching, distributed coordination, and data protection to their Python applications with minimal effort.
+
+## Features
+
+- **Function Result Caching**: Use the `@RedisMemoize` decorator to cache expensive function calls with automatic serialization, compression, and encryption
+- **Distributed Coordination**: Redis-based distributed locks and semaphores for coordinating access across multiple processes/machines
+- **Data Protection**: Multi-version encryption keys with automatic key rotation for sensitive cached data
+- **Async Support**: Full support for both synchronous and asynchronous applications
+- **Flexible Storage**: Choose between string or hash-based Redis storage patterns
+- **Modern Type Hints**: Full type safety with Python 3.12+ syntax
+
+## Installation
+
+```bash
+uv add rediskit
+# or
+poetry add rediskit
+```
+
+## Quick Start
+
+### Basic Setup
+
+```python
+from rediskit import RedisMemoize, InitRedisConnectionPool
+
+# Initialize Redis connection pool (call once at app startup)
+InitRedisConnectionPool()
+
+# Cache expensive function results
+@RedisMemoize(memoizeKey="expensive_calc", ttl=300)
+def expensive_calculation(tenantId: str, value: int) -> dict:
+    # Simulate expensive computation
+    import time
+    time.sleep(2)
+    return {"result": value * 42}
+
+# Usage
+result = expensive_calculation("tenant1", 10)  # Takes 2 seconds
+result = expensive_calculation("tenant1", 10)  # Returns instantly from cache
+```
+
+### Custom Redis Connection
+
+```python
+import redis
+from rediskit import RedisMemoize
+
+# Use your own Redis connection
+my_redis = redis.Redis(host='my-redis-host', port=6379, db=1)
+
+@RedisMemoize(
+    memoizeKey="custom_calc", 
+    ttl=600,
+    connection=my_redis
+)
+def my_function(tenantId: str, data: dict) -> dict:
+    return {"processed": data}
+```
+
+### Advanced Caching Options
+
+```python
+from rediskit import RedisMemoize
+
+# Hash-based storage with encryption
+@RedisMemoize(
+    memoizeKey=lambda tenantId, user_id: f"user_profile:{tenantId}:{user_id}",
+    ttl=3600,
+    storageType="hash",  # Store in Redis hash for efficient field access
+    enableEncryption=True,  # Encrypt sensitive data
+    cacheType="zipJson"  # JSON serialization with compression
+)
+def get_user_profile(tenantId: str, user_id: str) -> dict:
+    # Fetch user data from database
+    return {"user_id": user_id, "name": "John Doe", "email": "john@example.com"}
+
+# Dynamic TTL and cache bypass
+@RedisMemoize(
+    memoizeKey="dynamic_data",
+    ttl=lambda tenantId, priority: 3600 if priority == "high" else 300,
+    bypassCache=lambda tenantId, force_refresh: force_refresh
+)
+def get_dynamic_data(tenantId: str, priority: str, force_refresh: bool = False) -> dict:
+    return {"data": "fresh_data", "priority": priority}
+```
+
+### Async Support
+
+```python
+import asyncio
+from rediskit import RedisMemoize, InitAsyncRedisConnectionPool
+
+# Initialize async Redis connection pool
+await InitAsyncRedisConnectionPool()
+
+@RedisMemoize(memoizeKey="async_calc", ttl=300)
+async def async_expensive_function(tenantId: str, value: int) -> dict:
+    await asyncio.sleep(1)  # Simulate async work
+    return {"async_result": value * 100}
+
+# Usage
+result = await async_expensive_function("tenant1", 5)
+```
+
+### Distributed Locking
+
+```python
+from rediskit import GetRedisMutexLock, GetAsyncRedisMutexLock
+
+# Synchronous distributed lock
+with GetRedisMutexLock("critical_section", expire=30) as lock:
+    # Only one process can execute this block at a time
+    perform_critical_operation()
+
+# Async distributed lock
+async with GetAsyncRedisMutexLock("async_critical_section", expire=30) as lock:
+    await perform_async_critical_operation()
+```
+
+### Encryption Management
+
+```python
+from rediskit import Encrypter
+
+# Generate new encryption keys
+encrypter = Encrypter()
+new_key = encrypter.generateNewHexKey()
+
+# Encrypt/decrypt data manually
+encrypted = encrypter.encrypt("sensitive data", useZstd=True)
+decrypted = encrypter.decrypt(encrypted)
+```
+
+## Configuration
+
+Configure rediskit using environment variables:
+
+```bash
+# Redis connection settings
+export REDISKIT_REDIS_HOST="localhost"
+export REDISKIT_REDIS_PORT="6379"
+export REDISKIT_REDIS_PASSWORD=""
+
+# Encryption keys (base64-encoded JSON)
+export REDISKIT_ENCRYPTION_SECRET="eyJfX2VuY192MSI6ICI0MGViODJlNWJhNTJiNmQ4..."
+
+# Cache settings
+export REDISKIT_REDIS_TOP_NODE="my_app_cache"
+export REDISKIT_REDIS_SKIP_CACHING="false"
+```
+
+## API Reference
+
+### Core Decorators
+
+#### `@RedisMemoize`
+
+Cache function results in Redis with configurable options.
+
+**Parameters:**
+- `memoizeKey`: Cache key (string or callable)
+- `ttl`: Time to live in seconds (int, callable, or None)
+- `bypassCache`: Skip cache lookup (bool or callable)
+- `cacheType`: Serialization method ("zipJson" or "zipPickled")
+- `resetTtlUponRead`: Refresh TTL when reading from cache
+- `enableEncryption`: Encrypt cached data
+- `storageType`: Redis storage pattern ("string" or "hash")
+- `connection`: Custom Redis connection (optional)
+
+### Connection Management
+
+- `InitRedisConnectionPool()`: Initialize sync Redis connection pool
+- `InitAsyncRedisConnectionPool()`: Initialize async Redis connection pool
+- `GetRedisConnection()`: Get sync Redis connection
+- `GetAsyncRedisConnection()`: Get async Redis connection
+
+### Distributed Locking
+
+- `GetRedisMutexLock(name, expire, auto_renewal, id)`: Get sync distributed lock
+- `GetAsyncRedisMutexLock(name, expire, auto_renewal)`: Get async distributed lock
+
+### Encryption
+
+- `Encrypter(keyHexDict)`: Encryption/decryption with key versioning
+
+## Requirements
+
+- Python 3.12+
+- Redis server
+- Dependencies: redis, redis-lock, nacl, zstd
+
+## License
+Apache-2.0 license

rediskit-0.0.1/README.md

@@ -0,0 +1,196 @@
+# rediskit
+
+A Python toolkit that provides Redis-backed performance and concurrency primitives for applications. It enables developers to add caching, distributed coordination, and data protection to their Python applications with minimal effort.
+
+## Features
+
+- **Function Result Caching**: Use the `@RedisMemoize` decorator to cache expensive function calls with automatic serialization, compression, and encryption
+- **Distributed Coordination**: Redis-based distributed locks and semaphores for coordinating access across multiple processes/machines
+- **Data Protection**: Multi-version encryption keys with automatic key rotation for sensitive cached data
+- **Async Support**: Full support for both synchronous and asynchronous applications
+- **Flexible Storage**: Choose between string or hash-based Redis storage patterns
+- **Modern Type Hints**: Full type safety with Python 3.12+ syntax
+
+## Installation
+
+```bash
+uv add rediskit
+# or
+poetry add rediskit
+```
+
+## Quick Start
+
+### Basic Setup
+
+```python
+from rediskit import RedisMemoize, InitRedisConnectionPool
+
+# Initialize Redis connection pool (call once at app startup)
+InitRedisConnectionPool()
+
+# Cache expensive function results
+@RedisMemoize(memoizeKey="expensive_calc", ttl=300)
+def expensive_calculation(tenantId: str, value: int) -> dict:
+    # Simulate expensive computation
+    import time
+    time.sleep(2)
+    return {"result": value * 42}
+
+# Usage
+result = expensive_calculation("tenant1", 10)  # Takes 2 seconds
+result = expensive_calculation("tenant1", 10)  # Returns instantly from cache
+```
+
+### Custom Redis Connection
+
+```python
+import redis
+from rediskit import RedisMemoize
+
+# Use your own Redis connection
+my_redis = redis.Redis(host='my-redis-host', port=6379, db=1)
+
+@RedisMemoize(
+    memoizeKey="custom_calc", 
+    ttl=600,
+    connection=my_redis
+)
+def my_function(tenantId: str, data: dict) -> dict:
+    return {"processed": data}
+```
+
+### Advanced Caching Options
+
+```python
+from rediskit import RedisMemoize
+
+# Hash-based storage with encryption
+@RedisMemoize(
+    memoizeKey=lambda tenantId, user_id: f"user_profile:{tenantId}:{user_id}",
+    ttl=3600,
+    storageType="hash",  # Store in Redis hash for efficient field access
+    enableEncryption=True,  # Encrypt sensitive data
+    cacheType="zipJson"  # JSON serialization with compression
+)
+def get_user_profile(tenantId: str, user_id: str) -> dict:
+    # Fetch user data from database
+    return {"user_id": user_id, "name": "John Doe", "email": "john@example.com"}
+
+# Dynamic TTL and cache bypass
+@RedisMemoize(
+    memoizeKey="dynamic_data",
+    ttl=lambda tenantId, priority: 3600 if priority == "high" else 300,
+    bypassCache=lambda tenantId, force_refresh: force_refresh
+)
+def get_dynamic_data(tenantId: str, priority: str, force_refresh: bool = False) -> dict:
+    return {"data": "fresh_data", "priority": priority}
+```
+
+### Async Support
+
+```python
+import asyncio
+from rediskit import RedisMemoize, InitAsyncRedisConnectionPool
+
+# Initialize async Redis connection pool
+await InitAsyncRedisConnectionPool()
+
+@RedisMemoize(memoizeKey="async_calc", ttl=300)
+async def async_expensive_function(tenantId: str, value: int) -> dict:
+    await asyncio.sleep(1)  # Simulate async work
+    return {"async_result": value * 100}
+
+# Usage
+result = await async_expensive_function("tenant1", 5)
+```
+
+### Distributed Locking
+
+```python
+from rediskit import GetRedisMutexLock, GetAsyncRedisMutexLock
+
+# Synchronous distributed lock
+with GetRedisMutexLock("critical_section", expire=30) as lock:
+    # Only one process can execute this block at a time
+    perform_critical_operation()
+
+# Async distributed lock
+async with GetAsyncRedisMutexLock("async_critical_section", expire=30) as lock:
+    await perform_async_critical_operation()
+```
+
+### Encryption Management
+
+```python
+from rediskit import Encrypter
+
+# Generate new encryption keys
+encrypter = Encrypter()
+new_key = encrypter.generateNewHexKey()
+
+# Encrypt/decrypt data manually
+encrypted = encrypter.encrypt("sensitive data", useZstd=True)
+decrypted = encrypter.decrypt(encrypted)
+```
+
+## Configuration
+
+Configure rediskit using environment variables:
+
+```bash
+# Redis connection settings
+export REDISKIT_REDIS_HOST="localhost"
+export REDISKIT_REDIS_PORT="6379"
+export REDISKIT_REDIS_PASSWORD=""
+
+# Encryption keys (base64-encoded JSON)
+export REDISKIT_ENCRYPTION_SECRET="eyJfX2VuY192MSI6ICI0MGViODJlNWJhNTJiNmQ4..."
+
+# Cache settings
+export REDISKIT_REDIS_TOP_NODE="my_app_cache"
+export REDISKIT_REDIS_SKIP_CACHING="false"
+```
+
+## API Reference
+
+### Core Decorators
+
+#### `@RedisMemoize`
+
+Cache function results in Redis with configurable options.
+
+**Parameters:**
+- `memoizeKey`: Cache key (string or callable)
+- `ttl`: Time to live in seconds (int, callable, or None)
+- `bypassCache`: Skip cache lookup (bool or callable)
+- `cacheType`: Serialization method ("zipJson" or "zipPickled")
+- `resetTtlUponRead`: Refresh TTL when reading from cache
+- `enableEncryption`: Encrypt cached data
+- `storageType`: Redis storage pattern ("string" or "hash")
+- `connection`: Custom Redis connection (optional)
+
+### Connection Management
+
+- `InitRedisConnectionPool()`: Initialize sync Redis connection pool
+- `InitAsyncRedisConnectionPool()`: Initialize async Redis connection pool
+- `GetRedisConnection()`: Get sync Redis connection
+- `GetAsyncRedisConnection()`: Get async Redis connection
+
+### Distributed Locking
+
+- `GetRedisMutexLock(name, expire, auto_renewal, id)`: Get sync distributed lock
+- `GetAsyncRedisMutexLock(name, expire, auto_renewal)`: Get async distributed lock
+
+### Encryption
+
+- `Encrypter(keyHexDict)`: Encryption/decryption with key versioning
+
+## Requirements
+
+- Python 3.12+
+- Redis server
+- Dependencies: redis, redis-lock, nacl, zstd
+
+## License
+Apache-2.0 license