| Name | db4e JSON |
| Version |
0.25.1
JSON |
| download |
| home_page | None |
| Summary | A unified Monero XMR mining dashboard for deployment, operation and real-time analytics. |
| upload_time | 2025-07-18 18:07:41 |
| maintainer | None |
| docs_url | None |
| author | Nadim-Daniel Ghaznavi |
| requires_python | <4.0.0,>=3.10.20 |
| license | GPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Welcome
This is the home of **Db4E**, the **Database 4 Everything** project — A unified Monero XMR mining dashboard for deployment, operation and real-time analytics.
Db4E aims to be simple enough for new miners and flexible enough for advanced users. It’s still under active development, but the foundations are solid — and thanks to the [Textual Rapid Application Framework](https://textual.textualize.io/), progress is astonishingly fast.
**Now available on [PyPI](https://pypi.org/project/db4e/):**
```shell
pip install db4e
```
---
# Features Today
* 🎉 First official PyPI production release — now you can `pip install db4e`!
* 🛠️ Deployment manager with smooth vendor directory handling and update workflows.
* 🖥️ Fully integrated Textual-based TUI with interactive forms — no more manual command-line config.
* 🔒 Built-in security architecture with sudoers-based privilege management.
* 🧩 Modular design for future-proof upgrades of Monerod, P2Pool, and XMRig.
* ✅ Active development in Git branches, keeping `main` clean and stable.
The [https://xmr.osoyalce.com/](https://xmr.osoyalce.com/) site is generated by the old *Db4E* application. It houses live data from a small Monero XMR Mining farm and gives you a sense of what historical reporting can deliver.
---
# MongoDB Backend
Db4E includes a **MongoDB backend** to store historical mining data, logs, and configuration. The Db4E service runs continuously, monitors P2Pool logs and API responses, and writes structured records into MongoDB. That data powers features like [historical reports](https://xmr.osoyalce.com/pages/Reports.html) and the [interactive TUI](/pages/db4e-tui.py.html).
---
# Technology Stack
Db4E runs on [Debian Linux](https://www.debian.org/) and includes the following core components:
* [Db4E core application](https://github.com/NadimGhaznavi/Db4E) — built with the [Textual](https://textual.textualize.io/) RAD framework.
* [Monero Daemon (monerod)](https://www.getmonero.org/).
* [P2Pool daemon](https://github.com/SChernykh/p2pool).
* [XMRig](https://xmrig.com/) mining software.
* [MongoDB](https://www.mongodb.com/) for historical data storage.
* [systemd](https://en.wikipedia.org/wiki/Systemd) for service management.
---
# Release Management
For details on how development and releases are structured, see the
[Git Branching Strategy](/pages/Git-Branching-Strategy.html) and
[Git Commit Standard](/pages/Git-Commit-Standard.html).
---
# Getting Started
Refer to the [Getting Started](pages/Getting-Started.html) for detailed step on deploying Db4E.
---
# Coming Soon
* 📈 Rich historical data tracking for mining performance and yield.
* 🧙 Plotext-based terminal analytics directly in the TUI.
* 📢 PyPI release checking — automatic version notifications.
* 🔒 Full security architecture documentation.
* 🐞 Full unit + integration testing suite and CI/CD integration.
* 🕵️ Community building and open contributions — feedback welcomed!
---
# Community Feedback
*Questions? Ideas? Feedback?* Please go to the *db4e* project's [Discussions](https://github.com/NadimGhaznavi/db4e/discussions) page or checkout my [Blog](https://blog.osoyalce.com/).
---
# Donations
If you find Db4E useful, please consider [donating](/pages/Donations.html) to help support its ongoing development. Every contribution helps!
Raw data
{
"_id": null,
"home_page": null,
"name": "db4e",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.10.20",
"maintainer_email": null,
"keywords": null,
"author": "Nadim-Daniel Ghaznavi",
"author_email": "nghaznavi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5c/2c/559e8dca5fa758a6d1dbb35bf3ed16a366e8fa111ca3f481c894d2ff5839/db4e-0.25.1.tar.gz",
"platform": null,
"description": "# Welcome\n\nThis is the home of **Db4E**, the **Database 4 Everything** project \u2014 A unified Monero XMR mining dashboard for deployment, operation and real-time analytics.\n\nDb4E aims to be simple enough for new miners and flexible enough for advanced users. It\u2019s still under active development, but the foundations are solid \u2014 and thanks to the [Textual Rapid Application Framework](https://textual.textualize.io/), progress is astonishingly fast.\n\n**Now available on [PyPI](https://pypi.org/project/db4e/):** \n\n```shell\npip install db4e\n```\n\n---\n\n# Features Today\n\n* \ud83c\udf89 First official PyPI production release \u2014 now you can `pip install db4e`!\n* \ud83d\udee0\ufe0f Deployment manager with smooth vendor directory handling and update workflows.\n* \ud83d\udda5\ufe0f Fully integrated Textual-based TUI with interactive forms \u2014 no more manual command-line config.\n* \ud83d\udd12 Built-in security architecture with sudoers-based privilege management.\n* \ud83e\udde9 Modular design for future-proof upgrades of Monerod, P2Pool, and XMRig.\n* \u2705 Active development in Git branches, keeping `main` clean and stable.\n\n\nThe [https://xmr.osoyalce.com/](https://xmr.osoyalce.com/) site is generated by the old *Db4E* application. It houses live data from a small Monero XMR Mining farm and gives you a sense of what historical reporting can deliver.\n\n---\n\n# MongoDB Backend\n\nDb4E includes a **MongoDB backend** to store historical mining data, logs, and configuration. The Db4E service runs continuously, monitors P2Pool logs and API responses, and writes structured records into MongoDB. That data powers features like [historical reports](https://xmr.osoyalce.com/pages/Reports.html) and the [interactive TUI](/pages/db4e-tui.py.html).\n\n\n---\n\n# Technology Stack\n\nDb4E runs on [Debian Linux](https://www.debian.org/) and includes the following core components:\n\n* [Db4E core application](https://github.com/NadimGhaznavi/Db4E) \u2014 built with the [Textual](https://textual.textualize.io/) RAD framework.\n* [Monero Daemon (monerod)](https://www.getmonero.org/).\n* [P2Pool daemon](https://github.com/SChernykh/p2pool).\n* [XMRig](https://xmrig.com/) mining software.\n* [MongoDB](https://www.mongodb.com/) for historical data storage.\n* [systemd](https://en.wikipedia.org/wiki/Systemd) for service management.\n\n---\n\n# Release Management\n\nFor details on how development and releases are structured, see the \n[Git Branching Strategy](/pages/Git-Branching-Strategy.html) and \n[Git Commit Standard](/pages/Git-Commit-Standard.html).\n\n---\n\n# Getting Started\n\nRefer to the [Getting Started](pages/Getting-Started.html) for detailed step on deploying Db4E.\n\n---\n\n# Coming Soon\n\n* \ud83d\udcc8 Rich historical data tracking for mining performance and yield.\n* \ud83e\uddd9 Plotext-based terminal analytics directly in the TUI.\n* \ud83d\udce2 PyPI release checking \u2014 automatic version notifications.\n* \ud83d\udd12 Full security architecture documentation.\n* \ud83d\udc1e Full unit + integration testing suite and CI/CD integration.\n* \ud83d\udd75\ufe0f Community building and open contributions \u2014 feedback welcomed!\n\n---\n\n# Community Feedback\n\n*Questions? Ideas? Feedback?* Please go to the *db4e* project's [Discussions](https://github.com/NadimGhaznavi/db4e/discussions) page or checkout my [Blog](https://blog.osoyalce.com/).\n\n---\n\n# Donations\n\nIf you find Db4E useful, please consider [donating](/pages/Donations.html) to help support its ongoing development. Every contribution helps!\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A unified Monero XMR mining dashboard for deployment, operation and real-time analytics.",
"version": "0.25.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7de83d59bbfcf2e265f35c91d9a2ce5972ba7e7a29a2aceb4d1eec29963e7525",
"md5": "2182650b82b5574008aa1ca5f14056e0",
"sha256": "5e485af95b650ba39c72ba58c662a5b907b5c4ba15c5b60df89b4685973a18f2"
},
"downloads": -1,
"filename": "db4e-0.25.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2182650b82b5574008aa1ca5f14056e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.10.20",
"size": 12931408,
"upload_time": "2025-07-18T18:07:39",
"upload_time_iso_8601": "2025-07-18T18:07:39.085975Z",
"url": "https://files.pythonhosted.org/packages/7d/e8/3d59bbfcf2e265f35c91d9a2ce5972ba7e7a29a2aceb4d1eec29963e7525/db4e-0.25.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c2c559e8dca5fa758a6d1dbb35bf3ed16a366e8fa111ca3f481c894d2ff5839",
"md5": "f678f749e0017e68b74f7a06275792b3",
"sha256": "26ff3f05744414f09071073f6642ef94d5f4aa4bd85ec5637a26be4880b824bd"
},
"downloads": -1,
"filename": "db4e-0.25.1.tar.gz",
"has_sig": false,
"md5_digest": "f678f749e0017e68b74f7a06275792b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.10.20",
"size": 12845444,
"upload_time": "2025-07-18T18:07:41",
"upload_time_iso_8601": "2025-07-18T18:07:41.488784Z",
"url": "https://files.pythonhosted.org/packages/5c/2c/559e8dca5fa758a6d1dbb35bf3ed16a366e8fa111ca3f481c894d2ff5839/db4e-0.25.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 18:07:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "db4e"
}
