# VOXU
This Python package provides a request logging and viewing system for Flask applications. It allows developers to log and view HTTP requests made to their web applications, facilitating debugging and monitoring.
## Features:
- Middleware to log incoming requests to a database.
- Configurable database connection and table name.
- Dashboard to view logged requests.
- Authentication for accessing the dashboard (coming soon).
- Customizable logging fields and formats (in-progress).
- AI-powered request analysis and anomaly detection (in-progress).
## Usage:
### Installation:
`pip install voxu`
### Initialization:
Set SQLALCHEMY_DATABASE_URI in your Flask app configuration.
Set the table name for request logs (VOXU_LOG_TABLE) in your Flask app configuration. The default table name is 'http_request_logs'.
```python
from flask import Flask
from voxu import Voxu
app = Flask(__name__)
voxu = Voxu()
voxu.init_app(app)
```
**OR**
```python
from flask import Flask
from voxu import Voxu
app = Flask(__name__)
voxu = Voxu(app)
```
### Access Logs:
Navigate to /voxu/logs to view all logged requests in a HTML UI.
Configuration:
Configure the database URL and table name during initialization.
Customize middleware and database settings as needed.
## Contributing:
Contributions are welcome! Feel free to open issues or pull requests for bug fixes, enhancements, or new features.
## License:
This project is licensed under the MIT License - see the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/yorubadeveloper/voxu",
"name": "voxu",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Python, Flask, Logging, SQLAlchemy, PostgreSQL",
"author": "Yoruba Developer",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ef/6d/fe4c163a709df50bc3fc3089db420cf91f3402fc7c49f8fd13943f947a0f/voxu-0.1.8.tar.gz",
"platform": null,
"description": "# VOXU\n\nThis Python package provides a request logging and viewing system for Flask applications. It allows developers to log and view HTTP requests made to their web applications, facilitating debugging and monitoring.\n\n## Features:\n\n- Middleware to log incoming requests to a database.\n- Configurable database connection and table name.\n- Dashboard to view logged requests.\n- Authentication for accessing the dashboard (coming soon).\n- Customizable logging fields and formats (in-progress).\n- AI-powered request analysis and anomaly detection (in-progress).\n\n## Usage:\n\n### Installation:\n`pip install voxu`\n\n### Initialization:\nSet SQLALCHEMY_DATABASE_URI in your Flask app configuration.\nSet the table name for request logs (VOXU_LOG_TABLE) in your Flask app configuration. The default table name is 'http_request_logs'.\n```python\nfrom flask import Flask\nfrom voxu import Voxu\n\napp = Flask(__name__)\nvoxu = Voxu()\nvoxu.init_app(app)\n```\n**OR**\n```python\nfrom flask import Flask\nfrom voxu import Voxu\n\napp = Flask(__name__)\nvoxu = Voxu(app)\n```\n### Access Logs:\n\nNavigate to /voxu/logs to view all logged requests in a HTML UI.\nConfiguration:\n\nConfigure the database URL and table name during initialization.\nCustomize middleware and database settings as needed.\n\n## Contributing:\nContributions are welcome! Feel free to open issues or pull requests for bug fixes, enhancements, or new features.\n\n## License:\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/yorubadeveloper/voxu"
},
"split_keywords": [
"python",
" flask",
" logging",
" sqlalchemy",
" postgresql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30ef925d4d04154fd07a056e7bb141ca3d26017d2a1414cf3a3072ad5bc9a37a",
"md5": "864af78442fd9aa5332fe93155576a14",
"sha256": "0a61abd61ed4d8870df91a48c4f75a04bfdd876f0ff17a35c0e27d1a48b2e959"
},
"downloads": -1,
"filename": "voxu-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "864af78442fd9aa5332fe93155576a14",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7045,
"upload_time": "2024-03-25T08:19:23",
"upload_time_iso_8601": "2024-03-25T08:19:23.366765Z",
"url": "https://files.pythonhosted.org/packages/30/ef/925d4d04154fd07a056e7bb141ca3d26017d2a1414cf3a3072ad5bc9a37a/voxu-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef6dfe4c163a709df50bc3fc3089db420cf91f3402fc7c49f8fd13943f947a0f",
"md5": "f59161f0de0cded60f0d106e26e3beb3",
"sha256": "64bd5dac341f53e9b162c3e98caf755b6b4554df3fe00063ea7347bdc724ad7c"
},
"downloads": -1,
"filename": "voxu-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "f59161f0de0cded60f0d106e26e3beb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6005,
"upload_time": "2024-03-25T08:19:24",
"upload_time_iso_8601": "2024-03-25T08:19:24.805468Z",
"url": "https://files.pythonhosted.org/packages/ef/6d/fe4c163a709df50bc3fc3089db420cf91f3402fc7c49f8fd13943f947a0f/voxu-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 08:19:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yorubadeveloper",
"github_project": "voxu",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "blinker",
"specs": [
[
"==",
"1.7.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "Flask",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "greenlet",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "itsdangerous",
"specs": [
[
"==",
"2.1.2"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.3"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"2.1.5"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.27"
]
]
},
{
"name": "typing_extensions",
"specs": [
[
"==",
"4.10.0"
]
]
},
{
"name": "Werkzeug",
"specs": [
[
"==",
"3.0.1"
]
]
}
],
"lcname": "voxu"
}
JSON
