| Name | loguru-discord JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | |
| Summary | Lightweight, easy-to-use Discord sink for Loguru. |
| upload_time | 2024-02-11 23:06:18 |
| maintainer | |
| docs_url | None |
| author | EthanC |
| requires_python | >=3.12,<4.0 |
| license | MIT |
| keywords |
loguru
discord
logging
logger
sink
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Loguru-Discord
  
Lightweight, easy-to-use [Discord](https://discord.com/) sink for [Loguru](https://github.com/Delgan/loguru).
<p align="center">
<img src="https://i.imgur.com/aS7wt4c.png" draggable="false">
</p>
## Usage
Construct a handler with your preferred options, then add a new sink to Loguru.
### Installation
Support is guaranteed only for Python 3.11 or greater.
Once this requirement is met, simply install via your package manager of choice.
```
pip install loguru-discord
```
### Example
The following code is a complete example which demonstrates:
- Constructing a handler
- Adding the handler as a Loguru sink
- Catching an exception and firing a log
```py
from loguru import logger
from loguru_discord import DiscordSink
logger.add(DiscordSink("https://discord.com/api/webhooks/00000000/XXXXXXXX"))
try:
value: float = 1 / 0
except Exception as e:
logger.opt(exception=e).error("Lorem ipsum dolor sit amet")
```
## Customization
Upon constructing your handler, the following optional customizations are available via keyword arguments.
- **Username**: Username to use for the Discord Webhook message.
- **Avatar**: Image URL to use for the Discord Webhook message.
- **Embed**: Toggle whether to use plain codeblock formatting or rich embeds.
- **Suppress**: Prevent specific Exception types from being sent to Discord.
## Releases
Loguru-Discord follows [Semantic Versioning](https://semver.org/) for tagging releases of the project.
## Contributing
Bug fixes and optimizations are always welcome. See [`CONTRIBUTING.md`](https://github.com/EthanC/Loguru-Discord/blob/master/.github/CONTRIBUTING.md) for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "loguru-discord",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12,<4.0",
"maintainer_email": "",
"keywords": "loguru,discord,logging,logger,sink",
"author": "EthanC",
"author_email": "16727756+EthanC@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/78/11/82d6bdf11a1458253ae9ddf5102980ed9633c6d14a1e97affd9554b6b310/loguru_discord-1.1.1.tar.gz",
"platform": null,
"description": "# Loguru-Discord\n\n  \n\nLightweight, easy-to-use [Discord](https://discord.com/) sink for [Loguru](https://github.com/Delgan/loguru).\n\n<p align=\"center\">\n <img src=\"https://i.imgur.com/aS7wt4c.png\" draggable=\"false\">\n</p>\n\n## Usage\n\nConstruct a handler with your preferred options, then add a new sink to Loguru.\n\n### Installation\n\nSupport is guaranteed only for Python 3.11 or greater.\n\nOnce this requirement is met, simply install via your package manager of choice.\n\n```\npip install loguru-discord\n```\n\n### Example\n\nThe following code is a complete example which demonstrates:\n\n- Constructing a handler\n- Adding the handler as a Loguru sink\n- Catching an exception and firing a log\n\n```py\nfrom loguru import logger\nfrom loguru_discord import DiscordSink\n\nlogger.add(DiscordSink(\"https://discord.com/api/webhooks/00000000/XXXXXXXX\"))\n\ntry:\n value: float = 1 / 0\nexcept Exception as e:\n logger.opt(exception=e).error(\"Lorem ipsum dolor sit amet\")\n```\n\n## Customization\n\nUpon constructing your handler, the following optional customizations are available via keyword arguments.\n\n- **Username**: Username to use for the Discord Webhook message.\n- **Avatar**: Image URL to use for the Discord Webhook message.\n- **Embed**: Toggle whether to use plain codeblock formatting or rich embeds.\n- **Suppress**: Prevent specific Exception types from being sent to Discord.\n\n## Releases\n\nLoguru-Discord follows [Semantic Versioning](https://semver.org/) for tagging releases of the project.\n\n## Contributing\n\nBug fixes and optimizations are always welcome. See [`CONTRIBUTING.md`](https://github.com/EthanC/Loguru-Discord/blob/master/.github/CONTRIBUTING.md) for details.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Lightweight, easy-to-use Discord sink for Loguru.",
"version": "1.1.1",
"project_urls": {
"Issue Tracker": "https://github.com/EthanC/Loguru-Discord/issues",
"Twitter": "https://twitter.com/Mxtive"
},
"split_keywords": [
"loguru",
"discord",
"logging",
"logger",
"sink"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e68a3384a4274c4fe1dc0a87b861547c6df49ca69fa71d53fd3d21a1c96a7fac",
"md5": "84605232b76c51bcf45be136e70bb668",
"sha256": "87fbf4ff2177c579399862bb1290a7cf810b5dbd3f477dcdfd6fc4bc418dbaa4"
},
"downloads": -1,
"filename": "loguru_discord-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "84605232b76c51bcf45be136e70bb668",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12,<4.0",
"size": 4642,
"upload_time": "2024-02-11T23:06:16",
"upload_time_iso_8601": "2024-02-11T23:06:16.499511Z",
"url": "https://files.pythonhosted.org/packages/e6/8a/3384a4274c4fe1dc0a87b861547c6df49ca69fa71d53fd3d21a1c96a7fac/loguru_discord-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "781182d6bdf11a1458253ae9ddf5102980ed9633c6d14a1e97affd9554b6b310",
"md5": "66e98a22d9bd1297f874487e6fd4446c",
"sha256": "d19373b5e64c38cde28cc93d715e08686d0d199480696445f18a0dbf7de9a1fe"
},
"downloads": -1,
"filename": "loguru_discord-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "66e98a22d9bd1297f874487e6fd4446c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12,<4.0",
"size": 3955,
"upload_time": "2024-02-11T23:06:18",
"upload_time_iso_8601": "2024-02-11T23:06:18.075614Z",
"url": "https://files.pythonhosted.org/packages/78/11/82d6bdf11a1458253ae9ddf5102980ed9633c6d14a1e97affd9554b6b310/loguru_discord-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-11 23:06:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EthanC",
"github_project": "Loguru-Discord",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "loguru-discord"
}
