Skip to main content

Lightweight, easy-to-use Discord sink for Loguru.

Project description

Loguru-Discord

PyPI - Python Version PyPI - Status PyPI - Downloads

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.

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.3.tar.gz (3.8 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.3-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: loguru_discord-1.0.3.tar.gz
  • Upload date:
  • Size: 3.8 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.3.tar.gz
Algorithm Hash digest
SHA256 740f59649c91f3d6427f0abec5e5f13392215208acdf7e28e7207de389eb4fe1
MD5 2ba2252cd5df5c7c019616df7a3435fb
BLAKE2b-256 2492ed35ec8c0685121cb56666b80efaa51aa7b2744aaeccec8026ad51908fea

See more details on using hashes here.

File details

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

File metadata

  • Download URL: loguru_discord-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 4.5 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 824d38ff6120e3e07ce7cf110a98eb466c71cd4d9634fe09e10b6043fddb3947
MD5 00933c941e924a16bcf057e034056f3e
BLAKE2b-256 a270f3969c0193a127e191f5fc21208097f5385e4597b215278f10621e8dd9eb

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