persidict 0.36.5__tar.gz → 0.36.7__tar.gz

{persidict-0.36.5 → persidict-0.36.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: persidict
-Version: 0.36.5
+Version: 0.36.7
 Summary: Simple persistent key-value store for Python. Values are stored as files on a disk or as S3 objects on AWS cloud.
 Keywords: persistence,dicts,distributed,parallel
 Author: Vlad (Volodymyr) Pavlov
@@ -47,7 +47,10 @@ In contrast to traditional persistent dictionaries (e.g., Python’s `shelve)`,
 `persidict` is designed for distributed environments where multiple processes 
 on different machines concurrently work with the same store.
 
-## 2. Features
+## 2. Why Use It?
+
+## 2.1 Features
+
 * **Persistent Storage**: Save dictionaries to the local filesystem 
 (`FileDirDict`) or AWS S3 (`S3Dict`).
 * **Standard Dictionary API**: Use persidict objects like standard 
@@ -61,6 +64,23 @@ JSON (`json`), or plain text.
 instances of a specific class.
 * **Advanced Functionality**: Includes features like write-once dictionaries, 
 timestamping of entries, and tools for handling file-system-safe keys.
+* **Hierarchical Keys**: Keys can be sequences of strings, 
+creating a directory-like structure within the storage backend.
+
+## 2.2 Use Cases
+
+`persidict` is well-suited for a variety of applications, including:
+
+* **Caching**: Store results of expensive computations and retrieve them later, 
+even across different machines.
+* **Configuration Management**: Manage application settings 
+in a distributed environment, allowing for easy updates and access.
+* **Data Pipelines**: Share data between different stages 
+of a data processing pipeline.
+* **Distributed Task Queues**: Store task definitions and results 
+in a shared location.
+* **Memoization**: Cache function call results 
+in a persistent and distributed manner.
 
 ## 3. Usage
 
@@ -154,7 +174,7 @@ for all persistent dictionaries in the package. It's the foundation
 upon which everything else is built.
 * **`PersiDictKey`**: A type hint that specifies what can be used
 as a key in any `PersiDict`. It can be a `SafeStrTuple`, a single string, 
-* or a sequence of strings. When a `PesiDict` method requires a key as an input,
+or a sequence of strings. When a `PesiDict` method requires a key as an input,
 it will accept any of these types and convert them to a `SafeStrTuple` internally.
 * **`SafeStrTuple`**: The core data structure for keys. It's an immutable, 
 flat tuple of non-empty, URL/filename-safe strings, ensuring that 

{persidict-0.36.5 → persidict-0.36.7}/README.md

@@ -13,7 +13,10 @@ In contrast to traditional persistent dictionaries (e.g., Python’s `shelve)`,
 `persidict` is designed for distributed environments where multiple processes 
 on different machines concurrently work with the same store.
 
-## 2. Features
+## 2. Why Use It?
+
+## 2.1 Features
+
 * **Persistent Storage**: Save dictionaries to the local filesystem 
 (`FileDirDict`) or AWS S3 (`S3Dict`).
 * **Standard Dictionary API**: Use persidict objects like standard 
@@ -27,6 +30,23 @@ JSON (`json`), or plain text.
 instances of a specific class.
 * **Advanced Functionality**: Includes features like write-once dictionaries, 
 timestamping of entries, and tools for handling file-system-safe keys.
+* **Hierarchical Keys**: Keys can be sequences of strings, 
+creating a directory-like structure within the storage backend.
+
+## 2.2 Use Cases
+
+`persidict` is well-suited for a variety of applications, including:
+
+* **Caching**: Store results of expensive computations and retrieve them later, 
+even across different machines.
+* **Configuration Management**: Manage application settings 
+in a distributed environment, allowing for easy updates and access.
+* **Data Pipelines**: Share data between different stages 
+of a data processing pipeline.
+* **Distributed Task Queues**: Store task definitions and results 
+in a shared location.
+* **Memoization**: Cache function call results 
+in a persistent and distributed manner.
 
 ## 3. Usage
 
@@ -120,7 +140,7 @@ for all persistent dictionaries in the package. It's the foundation
 upon which everything else is built.
 * **`PersiDictKey`**: A type hint that specifies what can be used
 as a key in any `PersiDict`. It can be a `SafeStrTuple`, a single string, 
-* or a sequence of strings. When a `PesiDict` method requires a key as an input,
+or a sequence of strings. When a `PesiDict` method requires a key as an input,
 it will accept any of these types and convert them to a `SafeStrTuple` internally.
 * **`SafeStrTuple`**: The core data structure for keys. It's an immutable, 
 flat tuple of non-empty, URL/filename-safe strings, ensuring that 

{persidict-0.36.5 → persidict-0.36.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "persidict"
-version = "0.36.5"
+version = "0.36.7"
 description = "Simple persistent key-value store for Python. Values are stored as files on a disk or as S3 objects on AWS cloud."
 readme = "README.md"
 requires-python = ">=3.10"