Oh-My-PickleDB is an open source key-value store using Python's json module
Project description
OH-MY-PICKLEDB
oh-my-pickleDB is a lightweight, fast, and intuitive data manager written in python
📝 Table of Contents
- About
- Getting Started
- Deployment
- Usage
- Built Using
- TODO
- Contributing
- Authors
- Acknowledgments
- Useful Links
🧐 About
oh-my-pickleDB is an improved version of PickleDB, with notable differences compared to the original. Most important differences are:
- Cryptographic utils - Encrypt/Decrypt data content using FERNET symmetric encryption
- Code improvements - More readable documentation, improved code, etc...
- Data conversions - Byte, json, or str conversions
- More flexibility - Save/load data as bytes, json or str, you decide!
- Utilities - Export data as XML
🏁 Getting Started
Prerequisites
python~=3.9
cryptography~=3.4.8
setuptools~=58.1.0
fire~=0.4.0
Installing
# Using python pip
$ pip install oh-my-pickledb
# Using git
$ git clone https://github.com/tory1103/oh-my-pickledb.git
$ cd oh-my-pickledb
$ pip install -r requirements.txt
$ python setup.py install
🔧 Running the tests
Tests are found on tests folder.
In future versions, tests will be added inside code documentation as multi-row comments.
Break down into end to end tests
cd /tests
python3 <test_name>.py
🎈 Usage
from my_pickledb import PickleDB
database = PickleDB("test.json") # PickleDB object
database.set('key', 'value') # Creates new key and value
database.get('key') # Must return 'value'
database.save.as_json() # Must save database to file on specified path
🚀 Deployment
oh-my-pickleDB is a python library, when installed, just import it to your project.
import my_pickledb
from my_pickledb import *
⛏️ Built Using
- Python
- Json
- Data Structures
✍️ Authors
- @tory1103 - Idea, Concept & Initial work
See also the list of contributors who participated in this project.
🎉 Acknowledgements
✨ Useful links
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
oh-my-pickledb-0.4.2.dev0.tar.gz
(20.6 kB
view hashes)
Built Distribution
Close
Hashes for oh-my-pickledb-0.4.2.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a92cd6dafeb5f6447a4dea33f5dc15f8ce34fab261e2901740fc113be0f9925 |
|
MD5 | a63f04846e9ad6c89285a099104f81a6 |
|
BLAKE2b-256 | 78d4a3580b258e683e3882f76294ac8b307911dd80f3ffbf6a581eb61b9aeb30 |
Close
Hashes for oh_my_pickledb-0.4.2.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f62032c09d4510131e735098d6044b8a587d4f91b5d9576e48d9322d83329dac |
|
MD5 | eeea5aecb2472ba2c875a00a16747491 |
|
BLAKE2b-256 | fbcc8f752ed3c4a92848fa0f7ff4ac5031f32b685563b34b7299b3aecaf8bc67 |