Lightweight, easy-to-use Discord sink for Loguru.
Project description
Loguru-Discord
Lightweight, easy-to-use Discord sink for Loguru.
Usage
Construct a handler with your preferred options, then add a new sink to Loguru.
Installation
Support is guaranteed only for Python 3.12 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
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.
- Truncate: Toggle whether to trim length logs instead of uploading as a file.
- Suppress: Prevent specific Exception types from being sent to Discord.
Releases
Loguru-Discord follows Semantic Versioning for tagging releases of the project.
Contributing
Bug fixes and optimizations are always welcome. See CONTRIBUTING.md
for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for loguru_discord-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c97020a32d226e2474cf2edfbb673f04de840c387302b4ddbd3c43a000435bd2 |
|
MD5 | a785c2f843ef25ad4fa813e1817cfbd0 |
|
BLAKE2b-256 | adf0f7c9661b62ec72d770af33243c67eea36db19e240723b9c9cfc8ec46631f |