Skip to main content

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"))

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

loguru_discord-1.0.2.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

loguru_discord-1.0.2-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file loguru_discord-1.0.2.tar.gz.

File metadata

  • Download URL: loguru_discord-1.0.2.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for loguru_discord-1.0.2.tar.gz
Algorithm Hash digest
SHA256 c31f80a63a26e5d6c6bc3cbf138607a545a087496a6f69ef86d5bf7075bf9304
MD5 3cb306eccec697a845b9000e908700d5
BLAKE2b-256 9a49b00a5379d1857c000fa2105901327be46dde6827e1b3de285729b7b14760

See more details on using hashes here.

File details

Details for the file loguru_discord-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: loguru_discord-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for loguru_discord-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ea03c42abc0b960e60a933b3df783c32a5661c0c762a65bffa67da1a8ab99395
MD5 dc70ae124721924fb868c3dab6564b42
BLAKE2b-256 848905a949fc83bfedec7d094b3d04467aa4fd76f4f492f6749134038f6d2bbf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page