Skip to main content

A small Python 3 library and command line app to automate Docker health checks for discord.py bots.

Project description

Discord Health Check

CI PyPI - Downloads PyPI Black formatter

A small Python 3 library and command line app to automate Docker health checks for discord.py bots.

Installation

pip install discordhealthcheck

This will install both the Python library and the command line app, the python library is importable using import discordhealthcheck and the CLI app by using the command discordhealthcheck.

How It Works & Usage Examples

Python Library (Server)

The library has 1 function, start.

start takes a discord.Client object as well as optional parameters, and returns an awaitable that produces a asyncio.base_events.Server:

def start(
    client: discord.client,
    port: int = 40404,
    bot_max_latency: float = 0.5
) -> Awaitable[asyncio.base_events.Server]

start calls asyncio.start_server, creating an asyncio TCP socket server which listens for connections. Once a client connects, it tests the discord client for various things that indicate its health (latency, login status, etc.), and the result of this health check is then sent to the healthcheck client.

The returned Server object can be used to stop the server (e.g. healthcheck_server.close())

The default port for the socket server is 40404, if you change it you will need to use the --port flag on the client as well.

Call start once your event loop is running, generally a good place to call from is inside your setup_hook method:

import discord
import discordhealthcheck

class CustomClient(discord.Client):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    async def setup_hook(self):
        self.healthcheck_server = await discordhealthcheck.start(self)
        # Later you can close or check on self.healthcheck_server

CLI App (Client)

The CLI app is a simple client that connects to the server and determines its exit code from what the server sends; 0 for healthy, 1 for unhealthy.

Here's an example of using in a Dockerfile:

FROM python:3.11-slim-buster

# Copy files, install requirements, setup bot, etc.

RUN pip install discordhealthcheck

# The `|| exit 1` isn't required but it's good practice anyway.
HEALTHCHECK CMD discordhealthcheck || exit 1

CMD ["python", "/path/to/bot.py"]

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

discordhealthcheck-0.1.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

discordhealthcheck-0.1.1-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file discordhealthcheck-0.1.1.tar.gz.

File metadata

  • Download URL: discordhealthcheck-0.1.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for discordhealthcheck-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6772cfb9ce4437773b5ce1bdfb018c2bd380ae2ead49d7f07ed789a92f79b7fc
MD5 e783d42929a1b4a60af5cc365ca1c166
BLAKE2b-256 95536bfb908bcde047e0b010f850e3b0dddd63965de61118824b0bf195634bd4

See more details on using hashes here.

File details

Details for the file discordhealthcheck-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for discordhealthcheck-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 94f4b380dd7942a28dc99bb559ffe4b48285b4fd5cb8f3a553fe05de7c127c54
MD5 8fbb13ab9a468076ef7a00d2d4dcb2b2
BLAKE2b-256 f77e0f067c2af8586ebd4d280bb1d68b387afd4062dce2e8a8fa8abbf10d4499

See more details on using hashes here.

Supported by

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