redis-dict 3.2.0__py3-none-any.whl → 3.2.2__py3-none-any.whl

{redis_dict-3.2.0.dist-info → redis_dict-3.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: redis-dict
-Version: 3.2.0
+Version: 3.2.2
 Summary: Dictionary with Redis as storage backend
 Author-email: Melvin Bijman <bijman.m.m@gmail.com>
 License: MIT
@@ -42,7 +42,7 @@ Requires-Dist: types-redis>=4.6.0; extra == "dev"
 Requires-Dist: typing_extensions>=4.5.0; extra == "dev"
 Requires-Dist: attrs==22.2.0; extra == "dev"
 Requires-Dist: cffi==1.15.1; extra == "dev"
-Requires-Dist: cryptography==43.0.1; extra == "dev"
+Requires-Dist: cryptography==44.0.1; extra == "dev"
 Requires-Dist: exceptiongroup==1.1.1; extra == "dev"
 Requires-Dist: future==0.18.3; extra == "dev"
 Requires-Dist: pycparser==2.21; extra == "dev"
@@ -71,12 +71,14 @@ Requires-Dist: build; extra == "build"
 Requires-Dist: twine; extra == "build"
 
 # Redis-dict
+
 [![PyPI](https://img.shields.io/pypi/v/redis-dict.svg)](https://pypi.org/project/redis-dict/)
 [![CI](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml/badge.svg)](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/Attumm/redis-dict/graph/badge.svg?token=Lqs7McQGEs)](https://codecov.io/gh/Attumm/redis-dict)
+[![Documentation](https://img.shields.io/badge/docs-sphinx-blue.svg)](https://attumm.github.io/redis-dict/)
 [![Downloads](https://static.pepy.tech/badge/redis-dict/month)](https://pepy.tech/project/redis-dict)
 
-RedisDict is a Python library that offers a convenient and familiar interface for interacting with Redis, treating it as if it were a Python dictionary. Its goal is to help developers write clean, Pythonic code while using Redis as a storage solution for seamless distributed computing. This simple yet powerful library utilizes Redis as a key-value store and supports various data types, including strings, integers, floats, booleans, lists, and dictionaries. Additionally, developers can extend RedisDict to work with custom objects.
+RedisDict is a Python library that offers a convenient and familiar interface for interacting with Redis, treating it as if it were a Python dictionary. Its goal is to help developers write clean, Pythonic code while using Redis as a storage solution for seamless distributed computing. Redis-Dict utilizes Redis as a key-value store and supports various data types, including strings, integers, floats, booleans, lists, and dictionaries. Additionally, developers can extend RedisDict to work with custom objects.
 
 The library includes utility functions for more complex use cases such as caching, batching, and more. By leveraging Redis for efficient key-value storage, RedisDict enables high-performance data management, maintaining efficiency even with large datasets and Redis instances.
 
@@ -93,7 +95,6 @@ The library includes utility functions for more complex use cases such as cachin
 * Encryption: allows for storing data encrypted, while retaining the simple dictionary interface.
 
 ## Example
-Redis is an exceptionally fast database when used appropriately. RedisDict leverages Redis for efficient key-value storage, enabling high-performance data management.
 
 ```bash
 pip install redis-dict
@@ -110,6 +111,8 @@ True
 >>> dic["baz"] = "hello world"
 >>> dic
 {'foo': 42, 'baz': 'hello world'}
+>>> from datetime import datetime
+>>> dic["datetime"] = datetime.now()
 ```
 In Redis our example looks like this.
 ```
@@ -120,11 +123,13 @@ In Redis our example looks like this.
 "int:42"
 127.0.0.1:6379> GET "main:baz"
 "str:hello world"
+127.0.0.1:6379> GET "main:datetime"
+"datetime:2025-02-20T19:37:54.214274"
 ```
 
 ## Types
 
-### standard types
+### Standard types
 RedisDict supports a range of Python data types, from basic types to nested structures.
 Basic types are handled natively, while complex data types like lists and dictionaries, RedisDict uses JSON serialization, specifically avoiding [pickle](https://docs.python.org/3/library/pickle.html) due to its security vulnerabilities within distributed computing contexts.
 Although the library supports nested structures, the recommended best practice is to use RedisDict as a shallow dictionary.
@@ -132,6 +137,8 @@ This approach optimizes Redis database performance and efficiency by ensuring th
 Following types are supported: 
 `str, int, float, bool, NoneType, list, dict, tuple, set, datetime, date, time, timedelta, Decimal, complex, bytes, UUID, OrderedDict, defaultdict, frozenset`
 ```python
+from redis_dict import RedisDict
+
 from uuid import UUID
 from decimal import Decimal
 from collections import OrderedDict, defaultdict
@@ -239,7 +246,7 @@ dic = RedisDict(namespace="example")
 print(dic["foo"]) # outputs "bar"
 ```
 
-## More Examples
+## Additional Examples
 
 ### Caching made simple
 ```python
@@ -326,6 +333,19 @@ print(key, value)  # Output: 'c' 3 (example)
 # Using setdefault() method
 dic.setdefault("d", 4)
 print(dic["d"])  # Output: 4
+
+from datetime import datetime, timedelta
+
+# Redis dict support datetime
+dic["now"] = datetime.now()
+print(dic["now"])  # 2025-02-20 19:25:38.835816
+
+# SRedis dict support timedelta and more types
+dic["time"] = timedelta(days=1)
+print(dic["time"])  # 1 day, 0:00:00
+
+print(dic)
+{'now': datetime.datetime(2025, 2, 20, 19, 25, 38, 835816), 'time': datetime.timedelta(days=1), 'b': 2, 'd': 4}
 ```
 
 ### Additional Examples
@@ -333,7 +353,6 @@ For more advanced examples of RedisDict, please refer to the unit-test files in
 The unit-tests can be as used as a starting point.
 
 ### Nested types
-Nested Types
 RedisDict supports nested structures with mixed types through JSON serialization. The feature works by utilizing JSON encoding and decoding under the hood. While this represents an upgrade in functionality, the feature is not fully implemented and should be used with caution. For optimal performance, using shallow dictionaries is recommended.
 ```python
 from datetime import datetime, timedelta
@@ -355,12 +374,10 @@ encoded = json.dumps(data, cls=RedisDictJSONEncoder)
 result = json.loads(encoded, cls=RedisDictJSONDecoder)
 ```
 
-
 ### Extending RedisDict with Custom Types
 
 RedisDict supports custom type serialization. Here's how to add a new type:
 
-
 ```python
 import json
 

{redis_dict-3.2.0.dist-info → redis_dict-3.2.2.dist-info}/RECORD

@@ -3,8 +3,8 @@ redis_dict/core.py,sha256=E9mry6BqFnMjxuPtYBfQfuUPzWNzF65_dILMa-VgI4A,36994
 redis_dict/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 redis_dict/python_dict.py,sha256=FLsvxOfgkzsBJdRMkMrZw3w1usoGs-0FEL-j_ckfKts,12829
 redis_dict/type_management.py,sha256=ruyqswKqfte_G-ClTlV6ZuTmrTVkSsHFCy9LEdgblac,7700
-redis_dict-3.2.0.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
-redis_dict-3.2.0.dist-info/METADATA,sha256=k7dAwv3MM-W1fYvOprUzknBXHkZDRFJd_5uI4UMWpw4,17531
-redis_dict-3.2.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-redis_dict-3.2.0.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
-redis_dict-3.2.0.dist-info/RECORD,,
+redis_dict-3.2.2.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
+redis_dict-3.2.2.dist-info/METADATA,sha256=67iNEV13g4Wjk6sSgoYYZLf30ct4QDcLVj1dZp25xto,18011
+redis_dict-3.2.2.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+redis_dict-3.2.2.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
+redis_dict-3.2.2.dist-info/RECORD,,

{redis_dict-3.2.0.dist-info → redis_dict-3.2.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.2)
 Root-Is-Purelib: true
 Tag: py3-none-any