# Electrus Database
<p align="center">
<img src="assets/electrus.png" alt="Electrus Logo"/>
</p>
Electrus is a lightweight asynchronous & synchronous database module designed for Python, providing essential functionalities for data storage and retrieval.
## Table of Contents
- [Overview](#overview)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Examples](#examples)
- [Documantation](#documantation)
- [Support](#support)
## Overview
Electrus offers functionalities to manage collections and perform various operations such as insertion, updates, deletion, and data querying.
## Installation
To install Electrus, use the following pip command:
```bash
$ pip install electrus
```
## Getting Started
`Asynchronous`
```python
import electrus.asynchronous as electrus
client = electrus.Electrus()
database = client['mydb'] # enter you desire database
collection = database['mycollection']
```
`Synchronous`
```python
import electrus.synchronous as electrus
client = electrus.Electrus()
database = client['mydb'] # enter you desire database
collection = database['mycollection']
```
## Examples
### `Asynchronous`
### Inserting data operation
```python
# save this as main.py
import asyncio
import electrus as electrus
from electrus.exception import ElectrusException
client = electrus.Electrus()
database = client['mydb']
collection = database['mycollection']
async def handlecollectionOperations():
query = await collection.insertMany(data_list = sample_users, overwrite = False)
print(query.acknowledged)
query = await collection.find().select("*").execute()
if query.acknowledged:
print(json.dumps(query.raw_result, indent=2))
query = await collection.update(
filter = {"age": {"$gt": 30}}, multi = True,
update_data = {"$set": {"salary": 30000}}
)
print((await collection.find().select("*").execute()).raw_result)
query = await collection.delete().where(id = 1).execute()
if query.acknowledged:
print((await collection.find().select("*").execute()).raw_result)
if __name__ == "__main__":
import asyncio
asyncio.run(handlecollectionOperations())
```
`run the script`
```bash
$ python main.py
```
### `Synchronous`
### Inserting data operation
```python
# save this as main.py
import electrus.synchronous as electrus
from electrus.exception import ElectrusException
client = electrus.Electrus()
database = client['mydb']
collection = database['mycollection']
data = {
"id": "auto_inc",
"name": "Embrake | Electrus",
"email": ["embrakeproject@gmail.com", "control@vvfin.in"],
"role": "user"
}
try:
query = collection.insert_one(data)
if query:
print("Data inserted successfully!")
except ElectrusException as e:
print("Something went wrong {}".format(e))
```
`run the script`
```bash
$ python main.py
```
## Documantation
The complete documantation available at [http://electrus.vvfin.in](http://electrus.vvfin.in).
## Support
For any help and support feel free to contact us at `embrakeproject@gmail.com` or `control@vvfin.in`
## 🧰 Feature Roadmap
| Feature | Status |
| ---------------------- | ----------- |
| ✅ Atomic Write Engine | Complete |
| ✅ Smart Insert Logic | Complete |
| ✅ Modular I/O Layer | Complete |
| 🔄 Transaction Support | In Progress |
| 🔄 Advanced Query Ops | In Progress |
| 🧪 Middleware Engine | In Progress |
Have ideas? [Submit a GitHub Issue](https://github.com/axiomchronicles/electrus/issues)
---
## ❤️ Sponsor Electrus
Great open-source needs great community support.
If Electrus saves you time, sanity, or money — consider sponsoring:
[](https://github.com/sponsors/axiomchronicles)
> Every donation goes toward feature development, maintenance, and coffee ☕.
---
## 🔓 License
Electrus is open-source under the **BSD License** — flexible, permissive, and production-ready.
---
## 🎨 Final Thoughts
> Electrus was crafted for those who care about code elegance, data safety, and developer happiness.
<p align="center"><strong>⚡ Electrus — Build fearlessly. Code beautifully.</strong></p>
Raw data
{
"_id": null,
"home_page": "https://github.com/axiomchronicles/electrus",
"name": "axiomelectrus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "database, nosql, json, mongodb, async, synchronous, lightweight, electrus, python-database, data-storage, indexing, file-based-db",
"author": "Pawan Kumar",
"author_email": "aegis.invincible@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/63/ce/3cb17d861ee07d0dba1ef993ce2797acdb3501c2937c6c980b5f4f7ebed3/axiomelectrus-1.1.2.tar.gz",
"platform": null,
"description": "# Electrus Database\n\n<p align=\"center\">\n <img src=\"assets/electrus.png\" alt=\"Electrus Logo\"/>\n</p>\n\n\nElectrus is a lightweight asynchronous & synchronous database module designed for Python, providing essential functionalities for data storage and retrieval.\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Examples](#examples)\n- [Documantation](#documantation)\n- [Support](#support)\n## Overview\n\nElectrus offers functionalities to manage collections and perform various operations such as insertion, updates, deletion, and data querying.\n\n## Installation\n\nTo install Electrus, use the following pip command:\n\n```bash\n$ pip install electrus\n```\n\n## Getting Started\n\n`Asynchronous`\n\n```python\nimport electrus.asynchronous as electrus\n\nclient = electrus.Electrus()\ndatabase = client['mydb'] # enter you desire database\ncollection = database['mycollection']\n```\n\n`Synchronous`\n\n```python\nimport electrus.synchronous as electrus\n\nclient = electrus.Electrus()\ndatabase = client['mydb'] # enter you desire database\ncollection = database['mycollection']\n```\n\n## Examples\n\n### `Asynchronous`\n\n### Inserting data operation\n\n```python\n# save this as main.py\n\nimport asyncio\n\nimport electrus as electrus\nfrom electrus.exception import ElectrusException\n\nclient = electrus.Electrus()\ndatabase = client['mydb']\ncollection = database['mycollection']\n\nasync def handlecollectionOperations():\n query = await collection.insertMany(data_list = sample_users, overwrite = False)\n print(query.acknowledged)\n\n query = await collection.find().select(\"*\").execute()\n if query.acknowledged:\n print(json.dumps(query.raw_result, indent=2))\n\n query = await collection.update(\n filter = {\"age\": {\"$gt\": 30}}, multi = True,\n update_data = {\"$set\": {\"salary\": 30000}}\n )\n\n print((await collection.find().select(\"*\").execute()).raw_result)\n\n query = await collection.delete().where(id = 1).execute()\n if query.acknowledged:\n print((await collection.find().select(\"*\").execute()).raw_result)\n\nif __name__ == \"__main__\":\n import asyncio\n asyncio.run(handlecollectionOperations())\n\n```\n`run the script`\n```bash\n$ python main.py\n```\n### `Synchronous`\n\n### Inserting data operation\n\n```python\n# save this as main.py\n\nimport electrus.synchronous as electrus\nfrom electrus.exception import ElectrusException\n\nclient = electrus.Electrus()\ndatabase = client['mydb']\ncollection = database['mycollection']\n\ndata = {\n \"id\": \"auto_inc\",\n \"name\": \"Embrake | Electrus\",\n \"email\": [\"embrakeproject@gmail.com\", \"control@vvfin.in\"],\n \"role\": \"user\"\n}\n\ntry:\n query = collection.insert_one(data)\n if query:\n print(\"Data inserted successfully!\")\nexcept ElectrusException as e:\n print(\"Something went wrong {}\".format(e))\n\n```\n`run the script`\n```bash\n$ python main.py\n```\n\n## Documantation\n\nThe complete documantation available at [http://electrus.vvfin.in](http://electrus.vvfin.in).\n\n## Support\n\nFor any help and support feel free to contact us at `embrakeproject@gmail.com` or `control@vvfin.in`\n\n## \ud83e\uddf0 Feature Roadmap\n\n| Feature | Status |\n| ---------------------- | ----------- |\n| \u2705 Atomic Write Engine | Complete |\n| \u2705 Smart Insert Logic | Complete |\n| \u2705 Modular I/O Layer | Complete |\n| \ud83d\udd04 Transaction Support | In Progress |\n| \ud83d\udd04 Advanced Query Ops | In Progress |\n| \ud83e\uddea Middleware Engine | In Progress |\n\nHave ideas? [Submit a GitHub Issue](https://github.com/axiomchronicles/electrus/issues)\n\n---\n\n## \u2764\ufe0f Sponsor Electrus\n\nGreat open-source needs great community support.\n\nIf Electrus saves you time, sanity, or money \u2014 consider sponsoring:\n\n[](https://github.com/sponsors/axiomchronicles)\n\n> Every donation goes toward feature development, maintenance, and coffee \u2615.\n\n---\n\n## \ud83d\udd13 License\n\nElectrus is open-source under the **BSD License** \u2014 flexible, permissive, and production-ready.\n\n---\n\n## \ud83c\udfa8 Final Thoughts\n\n> Electrus was crafted for those who care about code elegance, data safety, and developer happiness.\n\n<p align=\"center\"><strong>\u26a1 Electrus \u2014 Build fearlessly. Code beautifully.</strong></p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Electrus is a lightweight, MongoDB-style asynchronous and synchronous database module designed for Python.",
"version": "1.1.2",
"project_urls": {
"Changelog": "https://github.com/axiomchronicles/electrus/releases",
"Documentation": "https://github.com/axiomchronicles/electrus/wiki",
"Homepage": "https://github.com/axiomchronicles/electrus",
"Source": "https://github.com/axiomchronicles/electrus",
"Tracker": "https://github.com/axiomchronicles/electrus/issues"
},
"split_keywords": [
"database",
" nosql",
" json",
" mongodb",
" async",
" synchronous",
" lightweight",
" electrus",
" python-database",
" data-storage",
" indexing",
" file-based-db"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "521640da1d6958e5692576df0813e296c0917667a12076c0c74ae1e64ef63276",
"md5": "2654cfb196a17a3d8c83f02a195ac5cd",
"sha256": "88b9dc3099ab517f3fb0b6f4c315e1cede2ed04616c29a6aa33e3ac1387449cb"
},
"downloads": -1,
"filename": "axiomelectrus-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2654cfb196a17a3d8c83f02a195ac5cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 89108,
"upload_time": "2025-08-07T09:33:09",
"upload_time_iso_8601": "2025-08-07T09:33:09.268577Z",
"url": "https://files.pythonhosted.org/packages/52/16/40da1d6958e5692576df0813e296c0917667a12076c0c74ae1e64ef63276/axiomelectrus-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "63ce3cb17d861ee07d0dba1ef993ce2797acdb3501c2937c6c980b5f4f7ebed3",
"md5": "2aec284a49bf588e8cf8f1fb68fda10a",
"sha256": "895128f65d64c38d992aa3a233a0f53e0241368da2bc312641799c5ca558285b"
},
"downloads": -1,
"filename": "axiomelectrus-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "2aec284a49bf588e8cf8f1fb68fda10a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 71789,
"upload_time": "2025-08-07T09:33:11",
"upload_time_iso_8601": "2025-08-07T09:33:11.316844Z",
"url": "https://files.pythonhosted.org/packages/63/ce/3cb17d861ee07d0dba1ef993ce2797acdb3501c2937c6c980b5f4f7ebed3/axiomelectrus-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 09:33:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "axiomchronicles",
"github_project": "electrus",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "axiomelectrus"
}
JSON
