Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sampathbalivada/dictstore
Local datastore for python that provides a dictionary interface.
https://github.com/sampathbalivada/dictstore
datastore dictionary python python3
Last synced: about 20 hours ago
JSON representation
Local datastore for python that provides a dictionary interface.
- Host: GitHub
- URL: https://github.com/sampathbalivada/dictstore
- Owner: sampathbalivada
- License: apache-2.0
- Created: 2021-12-08T18:29:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-19T16:36:37.000Z (almost 3 years ago)
- Last Synced: 2024-10-01T09:32:22.991Z (about 2 months ago)
- Topics: datastore, dictionary, python, python3
- Language: Python
- Homepage: https://pypi.org/project/dictstore/
- Size: 52.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dictstore
dictstore is a simple local data store for Python that aims to provide an interface similar to a python dictionary.
### Getting Started
##### Installation
```bash
pip install dictstore
```
##### Usage
```python3
# file: sample_1.py
from dictstore import DictStore
data = DictStore()
d[1] = 45
```
```python3
# file: sample_2.py
from dictstore import DictStore
data = DictStore()
print(d[1])
# output: 45
```
### Considerations
- dictstore uses an in memory dictionary to support fast reads
- using multiple DictStore instances for the same data file is not supported. Instead DictStore class returns the same instance for the same data file throughout the python code (Singleton behaviour).
- dictstore is best suited for CLIs or similar applications where values have to be remembered accross multiple runs.
- The data file is a plain readable text file and no encryption is offered by dictstore.
- dictstore might not be the fastest datastore, its promise is to get the work done and nothing more.
- dictstore will evaluate the type of value for all the nested objects in a given value, this is done using a Tree.
- This project has not be tested for concurrency safety. Please be cautious when using in projects involving multi-anything.
### Keys
All Hashable Data Types are supported as keys.
##### Hashable Data Types
| Name | Type |
| ----------- | ----------- |
| String | `str` |
| Integer | `int` |
| Float | `float` |
| Tuple | `tuple` |
### Values
Dictstore uses `ast` package and `ast.literal_eval` under the hood, so currently all the data types supported by `ast.literal_eval` except Ellipsis are supported as values.
strings, bytes, numbers, tuples, lists, dicts, sets, booleans, None.
For more information about ast.literal_eval visit the following link.
[https://docs.python.org/3/library/ast.html#ast.literal_eval](https://docs.python.org/3/library/ast.html#ast.literal_eval)