| Name | AshenDB JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | |
| Summary | Another stupid library for using json as Database |
| upload_time | 2023-09-18 22:19:37 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2023 Ashenite Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
json
mongodb
database
embedded-database
serverless
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://raw.githubusercontent.com/aurkaxi/AshenDB/master/docs/source/AshenDB_Logo.png
.. image:: https://readthedocs.org/projects/ashendb/badge/?version=latest
:target: https://ashendb.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
AshenDB
=======
**AshenDB** is a another stupid library for using json as Database. It mimics MongoDB functionalities.
Why AshenDB?
------------
- **MongoDB** : Needs a server to run. `You can clone your MongoDB to AshenDB <https://ashendb.readthedocs.io/en/latest/ashendb.client.html#ashendb.client.AshenDB.from_mongo>`_. AshenDB is highly inspired from MongoDB, it uses MongoDB like syntax, which makes it easy to use for beginners as well as for MongoDB users.
- **TinyDB** : Too simple. Query and Update Operators such as ``$set``, ``$inc`` are not supported. `Check all the supported Operators in AshenDB <https://ashendb.readthedocs.io/en/latest/ashendb.helper.html>`_. Also it is not thread safe.
- **JsonDB** : It is not thread safe. Neither it supports mongodb like syntax.
Why not AshenDB?
----------------
It is immature. It doesn't use separate server but uses json as a database. Which may be good for small or medium projects but for large and scalable projects it is recommended to use MongoDB with Redis as a cache.
Installation
------------
It is available on PyPI. You can install it using pip.
.. code-block:: bash
pip install ashendb
Usage
-----
.. code-block:: python
>>> from ashendb import AshenDB
# Assuming you are inside a async function
>>> db = await AshenDB.get_db('test')
>>> db
<AshenDB: test>
>>> coll = await db.get_coll('users')
>>> coll
<Collection: users>
>>> doc = await coll.get_doc('user1')
>>> doc
<Document: user1>
>>> print(doc)
{'_id': 'user1'}
Documentation
=============
Documentation is available at `Read the Docs <https://ashendb.readthedocs.io/en/latest/>`_.
Contributing
============
- Open an issue.
- Fork the repository -> New Branch -> Make Changes -> Open a Pull Request.
Raw data
{
"_id": null,
"home_page": "",
"name": "AshenDB",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "json,mongodb,database,embedded-database,serverless",
"author": "",
"author_email": "Abdullah Al Muaz <abdullahalmuaz15@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/43/3bcf50fa5ed117ad08dd669b30aad15f09088cd6d65b60d94918e0679a2f/AshenDB-0.0.8.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/aurkaxi/AshenDB/master/docs/source/AshenDB_Logo.png\n\n.. image:: https://readthedocs.org/projects/ashendb/badge/?version=latest\n :target: https://ashendb.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n \nAshenDB\n=======\n\n**AshenDB** is a another stupid library for using json as Database. It mimics MongoDB functionalities.\n\n\nWhy AshenDB?\n------------\n- **MongoDB** : Needs a server to run. `You can clone your MongoDB to AshenDB <https://ashendb.readthedocs.io/en/latest/ashendb.client.html#ashendb.client.AshenDB.from_mongo>`_. AshenDB is highly inspired from MongoDB, it uses MongoDB like syntax, which makes it easy to use for beginners as well as for MongoDB users.\n\n- **TinyDB** : Too simple. Query and Update Operators such as ``$set``, ``$inc`` are not supported. `Check all the supported Operators in AshenDB <https://ashendb.readthedocs.io/en/latest/ashendb.helper.html>`_. Also it is not thread safe. \n\n- **JsonDB** : It is not thread safe. Neither it supports mongodb like syntax.\n\nWhy not AshenDB?\n----------------\nIt is immature. It doesn't use separate server but uses json as a database. Which may be good for small or medium projects but for large and scalable projects it is recommended to use MongoDB with Redis as a cache.\n\nInstallation\n------------\nIt is available on PyPI. You can install it using pip.\n\n.. code-block:: bash\n\n pip install ashendb\n\nUsage\n-----\n\n.. code-block:: python\n\n >>> from ashendb import AshenDB\n # Assuming you are inside a async function\n >>> db = await AshenDB.get_db('test')\n >>> db\n <AshenDB: test>\n >>> coll = await db.get_coll('users')\n >>> coll\n <Collection: users>\n >>> doc = await coll.get_doc('user1')\n >>> doc\n <Document: user1>\n >>> print(doc)\n {'_id': 'user1'}\n\n\nDocumentation\n=============\nDocumentation is available at `Read the Docs <https://ashendb.readthedocs.io/en/latest/>`_.\n\nContributing\n============\n- Open an issue.\n- Fork the repository -> New Branch -> Make Changes -> Open a Pull Request.\n\n\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Ashenite Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Another stupid library for using json as Database",
"version": "0.0.8",
"project_urls": {
"Documentation": "https://ashendb.rtfd.io",
"Homepage": "https://github.com/aurkaxi/AshenDB"
},
"split_keywords": [
"json",
"mongodb",
"database",
"embedded-database",
"serverless"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a27e14c68bc6490bc1bb27f4fe3191eb99f84abe8c9b7df0cfac62dcec4f177",
"md5": "d237177de0eefe6c80dcc2f9cd37beae",
"sha256": "d07ffb1fddecd51043f146c00490170d2b62f2bb40a982ae59a2a24dda10681b"
},
"downloads": -1,
"filename": "AshenDB-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d237177de0eefe6c80dcc2f9cd37beae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13255,
"upload_time": "2023-09-18T22:19:35",
"upload_time_iso_8601": "2023-09-18T22:19:35.628603Z",
"url": "https://files.pythonhosted.org/packages/7a/27/e14c68bc6490bc1bb27f4fe3191eb99f84abe8c9b7df0cfac62dcec4f177/AshenDB-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba433bcf50fa5ed117ad08dd669b30aad15f09088cd6d65b60d94918e0679a2f",
"md5": "6278d5bcfe8ac5b8207c05f551df68fd",
"sha256": "e2bd476ae34863955b1068742f95416b4a61566ef5e28fd8a48953819cfbe888"
},
"downloads": -1,
"filename": "AshenDB-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "6278d5bcfe8ac5b8207c05f551df68fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10722,
"upload_time": "2023-09-18T22:19:37",
"upload_time_iso_8601": "2023-09-18T22:19:37.968645Z",
"url": "https://files.pythonhosted.org/packages/ba/43/3bcf50fa5ed117ad08dd669b30aad15f09088cd6d65b60d94918e0679a2f/AshenDB-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-18 22:19:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aurkaxi",
"github_project": "AshenDB",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ashendb"
}
