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.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
from loguru import logger
from loguru_discord import DiscordSink
logger.add(
DiscordSink(
"https://discord.com/api/webhooks/00000000/XXXXXXXX",
embed=True
),
level="WARNING",
)
try:
value: float = 1 / 0
except Exception as ex:
logger.error("Lorem ipsum dolor sit amet.", e=ex)
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.
- Trace: Toggle whether or not to include tracebacks (where available).
Releases
Loguru-Discord follows Semantic Versioning for tagging releases of the project.
Changelogs can be found on the Releases page in the Keep a Changelog format.
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.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73d34b5c3a6b6ab38dceeb9844d2543b7273b55ec3157f220415d0abb44bc557 |
|
MD5 | f250b623d24a4dbb8daf8cbedf79faed |
|
BLAKE2b-256 | ece2be970697294488ec31db5fb8342a043016434950de7b08e33c124f7c4c53 |