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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: redis-dict
-Version: 3.2.2
+Version: 3.2.4
 Summary: Dictionary with Redis as storage backend
 Author-email: Melvin Bijman <bijman.m.m@gmail.com>
 License: MIT
@@ -76,12 +76,18 @@ Requires-Dist: twine; extra == "build"
 [![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/)
+[![Supports Valkey](https://github.com/Attumm/redis-dict/actions/workflows/valkey_support.yml/badge.svg)](https://github.com/Attumm/redis-dict/actions/workflows/valkey_support.yml)
 [![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. 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.
 
+
+[Usage](#Usage) |  [Types](#Types) | [Expiration](#Expiration) | [Batching](#Batching) | [Custom Types](#Custom-Types) | [Security](#Security)
+
+---
+
 ## Features
 
 * Dictionary-like interface: Use familiar Python dictionary syntax to interact with Redis.
@@ -94,7 +100,7 @@ The library includes utility functions for more complex use cases such as cachin
 * Custom data: types: Add custom types encoding/decoding to store your data types.
 * Encryption: allows for storing data encrypted, while retaining the simple dictionary interface.
 
-## Example
+## Usage
 
 ```bash
 pip install redis-dict
@@ -349,7 +355,7 @@ print(dic)
 ```
 
 ### Additional Examples
-For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests/unit/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/tests/load/load_test.py#L1).
+For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests/unit/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/tests/load/tests_load.py#L1).
 The unit-tests can be as used as a starting point.
 
 ### Nested types
@@ -374,6 +380,7 @@ encoded = json.dumps(data, cls=RedisDictJSONEncoder)
 result = json.loads(encoded, cls=RedisDictJSONDecoder)
 ```
 
+## Custom Types
 ### Extending RedisDict with Custom Types
 
 RedisDict supports custom type serialization. Here's how to add a new type:
@@ -423,14 +430,22 @@ dic["3"] = "three"
 assert list(dic.keys()) == ["1", "2", "3"]
 ```
 
-For more information on [extending types](https://github.com/Attumm/redis-dict/blob/main/tests/unit/extend_types_tests.py).
-### Redis Encryption
+For more information on [extending types](https://github.com/Attumm/redis-dict/blob/main/tests/unit/tests_extend_types.py).
+
+## Security
+
+Security is an important aspect of production projects. Redis-dict was developed within a strict compliance environment.
+Best practice in Redis is to use passwords and network encryption through TLS. However, Redis-dict offers an additional feature by using extended types.
+It is possible to store the values of keys encrypted. The values are encrypted with AES GCM, which is currently considered best practice for security.
+
+### Storage Encryption
+For storing data values encrypted can be achieved using encrypted values, more documentation on that later.
+For now code example within this test file. [encrypted test](https://github.com/Attumm/redis-dict/blob/main/tests/unit/tests_encrypt.py).
+
+### Encryption Network
 Setup guide for configuring and utilizing encrypted Redis TLS for redis-dict.
 [Setup guide](https://github.com/Attumm/redis-dict/blob/main/docs/tutorials/encrypted_redis.MD)
 
-### Redis Storage Encryption
-For storing encrypted data values, it's possible to use extended types. Take a look at this [encrypted test](https://github.com/Attumm/redis-dict/blob/main/tests/unit/encrypt_tests.py).
-
 ### Tests
 The RedisDict library includes a comprehensive suite of tests that ensure its correctness and resilience. The test suite covers various data types, edge cases, and error handling scenarios. It also employs the Hypothesis library for property-based testing, which provides fuzz testing to evaluate the implementation
 

{redis_dict-3.2.2.dist-info → redis_dict-3.2.4.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.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.4.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
+redis_dict-3.2.4.dist-info/METADATA,sha256=92s7Nj78YPageZxqbMiDKL72mS0a68rb6aAce8WjcWs,18853
+redis_dict-3.2.4.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+redis_dict-3.2.4.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
+redis_dict-3.2.4.dist-info/RECORD,,