Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

dislog

wakatime GitHub Workflow Status pre-commit.ci status PyPI PyPI - Python Version

Previously discord-webhook-logger

Provides an interface for using a Discord webhook as a logger.

Designed to abstract away webhook-specific details, such as the JSON format, and provide a simple interface for logging messages.

Install

Simple as:

pip install dislog[discordpy]

You can use extras to define which implementation of discord.py you want to use.

  • discordpy: `discord.py

Example

Using dislog in your projects is dead simple. It behaves like any other logging.Handler.

For performance reasons, it even fires off a new thread for each log message, so you don't have to worry about blocking your main thread with costly HTTP requests.

from dislog import DiscordWebhookHandler
from logging import *

basicConfig(level=ERROR, handlers=[StreamHandler(), DiscordWebhookHandler("url", text_send_on_error="<@440468612365680650>")])

error("hi")

Demo

It also works with asynchronous code, simply pass the run_async keyword argument. This is optional and makes it use the event loop instead of a thread pool.

from dislog import DiscordWebhookHandler
from logging import *
from asyncio import run, sleep, get_running_loop

async def main():
    basicConfig(level=ERROR, handlers=[StreamHandler(), DiscordWebhookHandler("url", event_loop=get_running_loop(), text_send_on_error="<@440468612365680650>")])

    error("hi")

    await sleep(1)  # Give it some time to run!

run(main())

Async Demo

Contributing

Setup

git clone https://github.com/regulad/dislog
cd dislog
pip install -e .
pre-commit install

Testing

tox

Metadata

Release files for dislog 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dislog 3.0.0
File Size Uploaded
dislog-3.0.0.tar.gz 19.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dislog 3.0.0
File Interpreter ABI Platform
dislog-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 38.3 kB

Release files / dislog-3.0.0.tar.gz

Download URL dislog-3.0.0.tar.gz
Size 19.6 kB
Tags Source
SHA-256 checksum
How to use checksums
586d17e2d53bdb5c571fce3379e688a9c0038019f0144f43dba234aa08b89725
BLAKE2b-256 checksum
How to use checksums
a777bdb70251ef68eae5895e42992cbf966c11299098016f98ce5c4810028008
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.1

Release files / dislog-3.0.0-py3-none-any.whl

Download URL dislog-3.0.0-py3-none-any.whl
Size 18.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
763ca74e98e174bf317edd8bd25494f36cadce4b2e4a13a44db075610b8354c3
BLAKE2b-256 checksum
How to use checksums
40ddd6c73d718c291ebe1de51eaeb1ee58e30432eac58e027c5a6a7f5ba5aa9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.1
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page