<div align="center">
# InsightLog
[](https://github.com/Eldritchy/InsightLog#license) [](https://pypi.org/project/insightlog/) <a href="https://github.com/D-I-Projects/diec/blob/master/CONTRIBUTING.md"> <img src="https://img.shields.io/github/contributors-anon/Eldritchy/InsightLog" alt="Contributors badge" /></a> [](https://pepy.tech/project/insightlog)
```bash
pip install insightlog
```
A powerful logging utility for better logging, visualizations, and more.
</div>
## Overview
`InsightLog` is a powerful logging utility designed to enhance the development experience by providing rich logging features, custom formats, and data visualization capabilities.
## Features
- **Custom Log Levels**: Define log messages with specialized methods like `success`, `alert`, or `highlight`.
- **File Rotation**: Automatically manage log file sizes and backups using `RotatingFileHandler`.
- **Data Visualizations**: Generate ASCII-based bar charts, pie charts, and more.
- **Styled Logging**: Add colors, highlights, and borders to your logs for better readability.
- **Dynamic Progress Bars**: Smoothly integrated progress tracking using `tqdm`.
---
## Installation
Install `InsightLog` with pip:
```bash
pip install insightlog
```
---
## Usage
### Setting Up a Logger
```python
import insightlog
# Create an instance of InsightLogger
log_instance = insightlog.setup(name="MyApp")
# Logging examples
log_instance.success("This is a success log.")
log_instance.failure("This is a failure log.")
log_instance.alert("This is an alert log.")
log_instance.trace("This is a trace log.")
log_instance.highlight("This is a highlighted log.")
log_instance.bordered("This is a bordered log.")
log_instance.header("This is a header log.")
log_instance.debug_underline("This is a debug underline log.")
log_instance.alert_urgent("This is an urgent alert log.")
# Visualizations
log_instance.draw_bar_chart()
log_instance.draw_pie_chart()
log_instance.draw_line_chart()
log_instance.draw_scatter_plot()
log_instance.draw_waterfall_chart()
# Progress bar
log_instance.draw_progress_bar(total=100, duration=5, description="Loading...")
# Table
data = [["Name", "Age", "Location"], ["John", 30, "New York"], ["Jane", 25, "Los Angeles"]]
log_instance.print_table(data)
log_instance.print_ascii_art("Sample ASCII Art")
log_instance.color_gradient("Gradient Text", start_color="red", end_color="blue")
log_instance.spin_animation(duration=5)
```
---
## Requirements
- Python >= 3.9
- `termcolor`
- `tqdm`
## License
MIT License. See [LICENSE](LICENSE) for details.
---
Author: **Eldritchy**
Email: [eldritchy.help@gmail.com](mailto:eldritchy.help@gmail.com)
GitHub: [https://github.com/Eldritchy](https://github.com/Eldritchy)
Raw data
{
"_id": null,
"home_page": "https://github.com/Eldritchy/InsightLog",
"name": "InsightLog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "eldritchy, logging, log, logger, better, utility, developer tools",
"author": "Eldritchy",
"author_email": "eldritchy.help@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/de/de/9ef24f2b1b7a4905c4df639f7f0480dc2e21311e0d4a6221d200d98b6f3b/insightlog-1.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n \n# InsightLog\n\n[](https://github.com/Eldritchy/InsightLog#license) [](https://pypi.org/project/insightlog/) <a href=\"https://github.com/D-I-Projects/diec/blob/master/CONTRIBUTING.md\"> <img src=\"https://img.shields.io/github/contributors-anon/Eldritchy/InsightLog\" alt=\"Contributors badge\" /></a> [](https://pepy.tech/project/insightlog)\n\n```bash\npip install insightlog\n``` \n\nA powerful logging utility for better logging, visualizations, and more.\n\n</div>\n\n## Overview\n\n`InsightLog` is a powerful logging utility designed to enhance the development experience by providing rich logging features, custom formats, and data visualization capabilities.\n\n## Features\n\n- **Custom Log Levels**: Define log messages with specialized methods like `success`, `alert`, or `highlight`.\n- **File Rotation**: Automatically manage log file sizes and backups using `RotatingFileHandler`.\n- **Data Visualizations**: Generate ASCII-based bar charts, pie charts, and more.\n- **Styled Logging**: Add colors, highlights, and borders to your logs for better readability.\n- **Dynamic Progress Bars**: Smoothly integrated progress tracking using `tqdm`.\n\n---\n\n## Installation\n\nInstall `InsightLog` with pip:\n\n```bash\npip install insightlog\n```\n\n---\n\n## Usage\n\n### Setting Up a Logger\n\n```python\nimport insightlog\n\n# Create an instance of InsightLogger\nlog_instance = insightlog.setup(name=\"MyApp\")\n\n# Logging examples\nlog_instance.success(\"This is a success log.\")\nlog_instance.failure(\"This is a failure log.\")\nlog_instance.alert(\"This is an alert log.\")\nlog_instance.trace(\"This is a trace log.\")\nlog_instance.highlight(\"This is a highlighted log.\")\nlog_instance.bordered(\"This is a bordered log.\")\nlog_instance.header(\"This is a header log.\")\nlog_instance.debug_underline(\"This is a debug underline log.\")\nlog_instance.alert_urgent(\"This is an urgent alert log.\")\n\n# Visualizations\nlog_instance.draw_bar_chart()\nlog_instance.draw_pie_chart()\nlog_instance.draw_line_chart()\nlog_instance.draw_scatter_plot()\nlog_instance.draw_waterfall_chart()\n\n# Progress bar\nlog_instance.draw_progress_bar(total=100, duration=5, description=\"Loading...\")\n\n# Table\ndata = [[\"Name\", \"Age\", \"Location\"], [\"John\", 30, \"New York\"], [\"Jane\", 25, \"Los Angeles\"]]\nlog_instance.print_table(data)\nlog_instance.print_ascii_art(\"Sample ASCII Art\")\nlog_instance.color_gradient(\"Gradient Text\", start_color=\"red\", end_color=\"blue\")\nlog_instance.spin_animation(duration=5)\n```\n\n---\n\n## Requirements\n\n- Python >= 3.9\n- `termcolor`\n- `tqdm`\n\n## License\n\nMIT License. See [LICENSE](LICENSE) for details.\n\n---\n\nAuthor: **Eldritchy** \nEmail: [eldritchy.help@gmail.com](mailto:eldritchy.help@gmail.com) \nGitHub: [https://github.com/Eldritchy](https://github.com/Eldritchy)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A better logging utility with enhanced features.",
"version": "1.1",
"project_urls": {
"Bug Tracker": "https://github.com/Eldritchy/InsightLog/issues",
"Documentation": "https://github.com/Eldritchy/InsightLog/wiki",
"Download": "https://github.com/Eldritchy/InsightLog/archive/refs/tags/v1.1.tar.gz",
"Homepage": "https://github.com/Eldritchy/InsightLog",
"Source Code": "https://github.com/Eldritchy/InsightLog"
},
"split_keywords": [
"eldritchy",
" logging",
" log",
" logger",
" better",
" utility",
" developer tools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c79daca48923c6f99400742ddfa589726580639a7d56ff02de328b0d7a1eddf",
"md5": "4f36d8b5087c2f5212b7a4f5087607cf",
"sha256": "67e226728d45c07f1173695cbc0f393cdbac41fc0e65fc22275928db18df040e"
},
"downloads": -1,
"filename": "InsightLog-1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f36d8b5087c2f5212b7a4f5087607cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7171,
"upload_time": "2024-11-27T11:29:31",
"upload_time_iso_8601": "2024-11-27T11:29:31.274816Z",
"url": "https://files.pythonhosted.org/packages/7c/79/daca48923c6f99400742ddfa589726580639a7d56ff02de328b0d7a1eddf/InsightLog-1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dede9ef24f2b1b7a4905c4df639f7f0480dc2e21311e0d4a6221d200d98b6f3b",
"md5": "ccb8b6babab6c4eb7d8adcb53a04a792",
"sha256": "13a288278e2271193d2abcf5424fe8cd73a71e9449360bad19ffc2c16b14fed3"
},
"downloads": -1,
"filename": "insightlog-1.1.tar.gz",
"has_sig": false,
"md5_digest": "ccb8b6babab6c4eb7d8adcb53a04a792",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6786,
"upload_time": "2024-11-27T11:29:32",
"upload_time_iso_8601": "2024-11-27T11:29:32.865969Z",
"url": "https://files.pythonhosted.org/packages/de/de/9ef24f2b1b7a4905c4df639f7f0480dc2e21311e0d4a6221d200d98b6f3b/insightlog-1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 11:29:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Eldritchy",
"github_project": "InsightLog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "insightlog"
}
JSON
