Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adwaith-rajesh/strip.pysondb
A stripped-down version of pysondb
https://github.com/adwaith-rajesh/strip.pysondb
json pysondb python
Last synced: 1 day ago
JSON representation
A stripped-down version of pysondb
- Host: GitHub
- URL: https://github.com/adwaith-rajesh/strip.pysondb
- Owner: Adwaith-Rajesh
- License: mit
- Created: 2021-07-29T13:37:28.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-29T09:15:55.000Z (about 3 years ago)
- Last Synced: 2024-05-01T17:29:18.617Z (7 months ago)
- Topics: json, pysondb, python
- Language: Python
- Homepage:
- Size: 85.9 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# strip.pysondb
[](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/LICENSE)
[](https://dev.azure.com/adwaithrajesh/adwaith/_build?definitionId=8)
[](https://pypi.org/project/strip.pysondb/)
A stripped-down version of [pysondb](https://github.com/fredysomy/pysonDB) by [Fredy Somy](https://github.com/fredysomy).
---
## 🎉 Features.
- No third party packages needed
- No CLI
- No ImageUtils
- Use of [python naming conventions](https://www.python.org/dev/peps/pep-0008/#function-and-variable-names) in functions and classes.
- Just the code required to perform CRUD operation on JSON DB.
- Users can generate custom id's for their data.
- [DB clustering](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/cluster-docs.md) (User can access / modify multiple DB from a single point / class)
## ✏️️ Note
Even though it's called a stripped-down version, there are some huge differences in the way this package works.
- The data is not saved to file instantly, instead a methods needs to be called in order to do that.
- The user is supposed to pass the keys / column name for the DB during initialization of the `DB` class.
- Some of the new methods that are not derived from PysonDB are,
- [`pop`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#dbpop_id-str---dictstr-any--none)
- [`commit`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#saving-to-a-file)
- [`load`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#load-values-from-a-file)
- [`values`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#get-the-first-n-values-from-the-db)
- [`set_id_generator`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#using-a-custom-id-generator)
- [`id_exists`](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md#check-whether-an-id-exists-in-the-db)
---
## 🔻 Installation
- ### Delete the original pysondb before installing this version. (Might cause conflicts)
- ### From Pypi
```commandline
pip3 install strip.pysondb
```
---
## 📚 Usage
- ## tl;dr
```python
from pysondb import DB
db = DB(keys=["name", "age"])
db.add({
"name": "name1",
"age": 1
})
print(db)
```
```python
from pysondb import DB
from pysondb import Cluster
users = DB(keys=["username", "password"])
posts = DB(keys=["username", "title", "content"])
c = Cluster({"users": users, "posts": posts})
c.users.add({"username": "adwaith", "password": "123@45"})
c.posts.add("username": "adwaith", "title": "Hello", "content": "Hello WOrld")
c.commit("cluster.json", indent=2) # use a single json file to store all the data from all the DB in the cluster
```
### Click [here](https://github.com/Adwaith-Rajesh/strip.pysondb/blob/master/docs/docs.md) to see the complete docs.
---
## 🥰 Contributing to strip.pysondb
Read the **CONTRIBUTING.md** for the code design style and linting preferences.
Once you've gone though it, follow theses steps.
- Fork this repo.
- Create a new branch from master. (Very important)
- Make your required changes with good commit messages.
- Write the test to make sure that your changes work.
- Create a pull request.
- Bug the maintainers until it get merged 😊.
## 🙊 Have any issue or feature request.
Create an issue or join our Discord server [Here](https://discord.gg/BxMbWzZe2Z).
---
