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 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.
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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1248cb57bb2eba40fca4fcf519f489c4409ccbe189482e1a16c924169dba79ec |
|
MD5 | 0b84735bd66906ef251ce5494ea77519 |
|
BLAKE2b-256 | 1f51686a9dd881b73e84b18a2c3222c7e182453337f28b5f6b434a23b6166f5e |