<h1 align="center">CookieDB</h1>
<p align="center">A safe, fast and simple database.</p>
<p align="center" style="margin-bottom: 15px">
<a href="https://github.com/jaedsonpys/cookiedb/releases">
<img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/jaedsonpys/cookiedb?include_prereleases&color=green&label=version">
</a>
<a href="https://github.com/jaedsonpys/cookiedb/blob/master/LICENSE" style="margin-right: 5px; margin-left: 5px">
<img alt="PyPI - License" src="https://img.shields.io/pypi/l/cookiedb?color=yellow">
</a>
<a href="https://pypi.org/project/cookiedb">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/cookiedb?color=blue">
</a>
</p>
CookieDB is a noSQL database that uses the `document` model with all data encrypted using AES-256, take advantage of *performance and security* to create your projects that need **fast storage** and simple to use, where you have full control over the data. Read the [full CookieDB documentation](https://jaedsonpys.github.io/cookiedb) to understand the methods available to create, read, update, and delete data in the database.
## Getting started
First, let's start by performing a quick installation of CookieDB using the PIP package manager:
```
pip install cookiedb
```
If you prefer, you can perform the installation manually using Git. See below how to do this:
```
git clone https://github.com/jaedsonpys/cookiedb.git
cd cookiedb/
python3 setup.py install
```
### Usage example
Take a look at this **simple example of using** the database, where we create and get some data (the complete example can be found in [examples/example.py](https://github.com/jaedsonpys/cookiedb/blob/master/examples/example.py))
```python
from cookiedb import CookieDB
database = CookieDB('MyDatabase', key='secret')
database.add('languages/python', {'name': 'Python', 'ext': '.py'})
python_ext = database.get('languages/python/ext')
print(f'Python extension: {python_ext}')
```
You can find more usage examples in the [examples/ directory](https://github.com/jaedsonpys/cookiedb/tree/master/examples)
# License
```
Apache License
Copyright 2023 Jaedson Silva
```
This project uses the *Apache License*, anyone can use this project as long as the license conditions allow. [See more about the license](https://github.com/jaedsonpys/cookiedb/blob/master/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/jaedsonpys/cookiedb",
"name": "cookiedb",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "database,noSQL,document,db,engine",
"author": "Jaedson Silva",
"author_email": "jaedson.dev@proton.me",
"download_url": "https://files.pythonhosted.org/packages/96/3a/a599cc8506efa1cac0d7b9daf8fe0159dd9a4c8350981570cacd4fb0dc1b/cookiedb-9.0.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">CookieDB</h1>\n<p align=\"center\">A safe, fast and simple database.</p>\n\n<p align=\"center\" style=\"margin-bottom: 15px\">\n <a href=\"https://github.com/jaedsonpys/cookiedb/releases\">\n <img alt=\"GitHub release (latest by date including pre-releases)\" src=\"https://img.shields.io/github/v/release/jaedsonpys/cookiedb?include_prereleases&color=green&label=version\">\n </a>\n <a href=\"https://github.com/jaedsonpys/cookiedb/blob/master/LICENSE\" style=\"margin-right: 5px; margin-left: 5px\">\n <img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/cookiedb?color=yellow\">\n </a>\n <a href=\"https://pypi.org/project/cookiedb\">\n <img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/cookiedb?color=blue\">\n </a>\n</p>\n\nCookieDB is a noSQL database that uses the `document` model with all data encrypted using AES-256, take advantage of *performance and security* to create your projects that need **fast storage** and simple to use, where you have full control over the data. Read the [full CookieDB documentation](https://jaedsonpys.github.io/cookiedb) to understand the methods available to create, read, update, and delete data in the database.\n\n## Getting started\n\nFirst, let's start by performing a quick installation of CookieDB using the PIP package manager:\n\n```\npip install cookiedb\n```\n\nIf you prefer, you can perform the installation manually using Git. See below how to do this:\n\n```\ngit clone https://github.com/jaedsonpys/cookiedb.git\ncd cookiedb/\npython3 setup.py install\n```\n\n### Usage example\n\nTake a look at this **simple example of using** the database, where we create and get some data (the complete example can be found in [examples/example.py](https://github.com/jaedsonpys/cookiedb/blob/master/examples/example.py))\n\n```python\nfrom cookiedb import CookieDB\n\ndatabase = CookieDB('MyDatabase', key='secret')\ndatabase.add('languages/python', {'name': 'Python', 'ext': '.py'})\n\npython_ext = database.get('languages/python/ext')\nprint(f'Python extension: {python_ext}')\n```\n\nYou can find more usage examples in the [examples/ directory](https://github.com/jaedsonpys/cookiedb/tree/master/examples)\n\n# License\n\n```\nApache License\nCopyright 2023 Jaedson Silva\n```\n\nThis project uses the *Apache License*, anyone can use this project as long as the license conditions allow. [See more about the license](https://github.com/jaedsonpys/cookiedb/blob/master/LICENSE).\n",
"bugtrack_url": null,
"license": "Apache License",
"summary": "CookieDB is a noSQL document database.",
"version": "9.0.0",
"project_urls": {
"Documentation": "https://jaedsonpys.github.io/cookiedb/",
"Homepage": "https://github.com/jaedsonpys/cookiedb",
"License": "https://github.com/jaedsonpys/cookiedb/blob/master/LICENSE"
},
"split_keywords": [
"database",
"nosql",
"document",
"db",
"engine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "963aa599cc8506efa1cac0d7b9daf8fe0159dd9a4c8350981570cacd4fb0dc1b",
"md5": "77920a24cc398242671877f335f35cf1",
"sha256": "176a0da144a43ac827a2a318188636441ea27e29574b6cef411d69a73f6273d1"
},
"downloads": -1,
"filename": "cookiedb-9.0.0.tar.gz",
"has_sig": false,
"md5_digest": "77920a24cc398242671877f335f35cf1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13404,
"upload_time": "2023-08-06T19:03:15",
"upload_time_iso_8601": "2023-08-06T19:03:15.261209Z",
"url": "https://files.pythonhosted.org/packages/96/3a/a599cc8506efa1cac0d7b9daf8fe0159dd9a4c8350981570cacd4fb0dc1b/cookiedb-9.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-06 19:03:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jaedsonpys",
"github_project": "cookiedb",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "cookiedb"
}
JSON
