| Name | tkloguru JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A custom Tkinter widget that displays Loguru log messages in real-time with support for styling and colors. Monitor application logs directly within your Tkinter GUI. |
| upload_time | 2024-09-03 17:26:51 |
| maintainer | None |
| docs_url | None |
| author | Aareon Sullivan |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Loguru Tkinter Widget
A thread-safe, customizable Tkinter widget for displaying Loguru logs in real-time.
## Features
- Real-time log display in a Tkinter application
- Thread-safe implementation using a queue
- Customizable color modes for log levels
- Adjustable maximum number of displayed log lines
- Optional scrollbar
- Easy integration with existing Loguru logger
## Installation
1. Ensure you have Python 3.6+ installed on your system.
2. Install the required dependencies:
```bash
pip install tkloguru
```
3. Copy the `LoguruWidget` class and related functions into your project.
## Usage
Here's a basic example of how to use the Loguru Tkinter Widget:
```python
import tkinter as tk
from loguru import logger
from loguru_widget import LoguruWidget, setup_logger
root = tk.Tk()
root.title("Loguru Tkinter Widget Demo")
root.geometry("600x400")
log_widget = LoguruWidget(root, show_scrollbar=True, color_mode='level', max_lines=1000)
log_widget.pack(expand=True, fill=tk.BOTH, padx=10, pady=10)
setup_logger(log_widget)
# Example log messages
logger.debug("This is a debug message")
logger.info("This is an info message")
logger.success("This is a success message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.critical("This is a critical message")
root.mainloop()
```
## Customization
The `LoguruWidget` class accepts several parameters for customization:
- `master`: The parent Tkinter widget (required)
- `show_scrollbar`: Boolean to show/hide the scrollbar (default: True)
- `color_mode`: String to set the coloring mode ('level', 'message', or 'full') (default: 'level')
- `max_lines`: Integer to set the maximum number of displayed log lines (default: 1000)
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- [Loguru](https://github.com/Delgan/loguru) for the excellent logging library
- [Tkinter](https://docs.python.org/3/library/tkinter.html) for the GUI framework
Raw data
{
"_id": null,
"home_page": null,
"name": "tkloguru",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Aareon Sullivan",
"author_email": "askully13@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e6/c0/3308477002a53b7ec4a5f1a5ee1fd338c00771fdba4bab4ef7f94af3f029/tkloguru-0.1.2.tar.gz",
"platform": null,
"description": "# Loguru Tkinter Widget\n\nA thread-safe, customizable Tkinter widget for displaying Loguru logs in real-time.\n\n\n\n## Features\n\n- Real-time log display in a Tkinter application\n- Thread-safe implementation using a queue\n- Customizable color modes for log levels\n- Adjustable maximum number of displayed log lines\n- Optional scrollbar\n- Easy integration with existing Loguru logger\n\n## Installation\n\n1. Ensure you have Python 3.6+ installed on your system.\n2. Install the required dependencies:\n\n```bash\npip install tkloguru\n```\n\n3. Copy the `LoguruWidget` class and related functions into your project.\n\n## Usage\n\nHere's a basic example of how to use the Loguru Tkinter Widget:\n\n```python\nimport tkinter as tk\nfrom loguru import logger\nfrom loguru_widget import LoguruWidget, setup_logger\n\nroot = tk.Tk()\nroot.title(\"Loguru Tkinter Widget Demo\")\nroot.geometry(\"600x400\")\n\nlog_widget = LoguruWidget(root, show_scrollbar=True, color_mode='level', max_lines=1000)\nlog_widget.pack(expand=True, fill=tk.BOTH, padx=10, pady=10)\n\nsetup_logger(log_widget)\n\n# Example log messages\nlogger.debug(\"This is a debug message\")\nlogger.info(\"This is an info message\")\nlogger.success(\"This is a success message\")\nlogger.warning(\"This is a warning message\")\nlogger.error(\"This is an error message\")\nlogger.critical(\"This is a critical message\")\n\nroot.mainloop()\n```\n\n## Customization\n\nThe `LoguruWidget` class accepts several parameters for customization:\n\n- `master`: The parent Tkinter widget (required)\n- `show_scrollbar`: Boolean to show/hide the scrollbar (default: True)\n- `color_mode`: String to set the coloring mode ('level', 'message', or 'full') (default: 'level')\n- `max_lines`: Integer to set the maximum number of displayed log lines (default: 1000)\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- [Loguru](https://github.com/Delgan/loguru) for the excellent logging library\n- [Tkinter](https://docs.python.org/3/library/tkinter.html) for the GUI framework\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A custom Tkinter widget that displays Loguru log messages in real-time with support for styling and colors. Monitor application logs directly within your Tkinter GUI.",
"version": "0.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/Aareon/TkLoguru/issues",
"Homepage": "https://github.com/Aareon/TkLoguru"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "959723de03eed35529743ad779b41bf8becd0148326eb0dd855b8dfbcae5a269",
"md5": "c082a3b9b44a6f24cd44ccda0e1ffb11",
"sha256": "6793c18100226a5c797d60755a0de37f6b8ab056e036d417392064041f70aeda"
},
"downloads": -1,
"filename": "tkloguru-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c082a3b9b44a6f24cd44ccda0e1ffb11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 6566,
"upload_time": "2024-09-03T17:26:50",
"upload_time_iso_8601": "2024-09-03T17:26:50.286421Z",
"url": "https://files.pythonhosted.org/packages/95/97/23de03eed35529743ad779b41bf8becd0148326eb0dd855b8dfbcae5a269/tkloguru-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6c03308477002a53b7ec4a5f1a5ee1fd338c00771fdba4bab4ef7f94af3f029",
"md5": "0da4f95062d62565fc2465097632cd2f",
"sha256": "d13c231da165fe9c519c271050e754005e65b8406d4015db2a7c6f260bfe8399"
},
"downloads": -1,
"filename": "tkloguru-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "0da4f95062d62565fc2465097632cd2f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 6179,
"upload_time": "2024-09-03T17:26:51",
"upload_time_iso_8601": "2024-09-03T17:26:51.831812Z",
"url": "https://files.pythonhosted.org/packages/e6/c0/3308477002a53b7ec4a5f1a5ee1fd338c00771fdba4bab4ef7f94af3f029/tkloguru-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-03 17:26:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Aareon",
"github_project": "TkLoguru",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tkloguru"
}
