https://github.com/imyizhang/jsonabledb
A lightweight document-oriented database based on JSON
https://github.com/imyizhang/jsonabledb
database documentdb json jsonable jsonify nosql
Last synced: about 1 month ago
JSON representation
A lightweight document-oriented database based on JSON
- Host: GitHub
- URL: https://github.com/imyizhang/jsonabledb
- Owner: imyizhang
- License: bsd-3-clause
- Created: 2024-04-24T13:57:50.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T14:11:15.000Z (about 2 years ago)
- Last Synced: 2024-04-24T16:24:31.149Z (about 2 years ago)
- Topics: database, documentdb, json, jsonable, jsonify, nosql
- Language: Python
- Homepage: https://pypi.org/project/jsonabledb
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonableDB
[![GitHub][github_badge]][github_link] [![PyPI][pypi_badge]][pypi_link]
**jsonableDB** is a lightweight document-oriented database based on JSON.
## Installation
```bash
pip install jsonabledb
```
## Quickstart
Get your documents prepared
```python
documents = [
{...},
{...},
...
]
```
Jsonify your documents as a JSON file using **jsonableDB**
```python
from jsonable import jsonify
jsonify(documents, "collection_name", "database_name")
```
Retrieve all your documents in the **jsonableDB**
```python
import jsonable
client = jsonable.Client()
collection = client["database_name"]["collection_name"]
collection.find()
```
## License
**jsonableDB** has a BSD-3-Clause license, as found in the [LICENSE](https://github.com/imyizhang/jsonabledb/blob/main/LICENSE) file.
## Contributing
Thanks for your interest in contributing to **jsonableDB**! Please feel free to create a pull request.
## Changelog
**jsonableDB 0.0.2**
* Support to jsonify documents as a JSON file
**jsonableDB 0.0.1**
* First release
[github_badge]: https://badgen.net/badge/icon/GitHub?icon=github&color=black&label
[github_link]: https://github.com/imyizhang/jsonabledb
[pypi_badge]: https://badgen.net/pypi/v/jsonabledb?icon=pypi&color=black&label
[pypi_link]: https://www.pypi.org/project/jsonabledb