Skip to main content

Simple Discord webhook wrapper

Project description

SimpleHook

SimpleHook is a minimalistic Python wrapper for Discord webhooks. It allows you to easily send messages, files, and embedded content to a Discord channel using just a few lines of code.

PyPI Python License Size

🔧 Features

  • Send plain text messages
  • Customize username and avatar
  • Mention users or everyone/here
  • Use text-to-speech
  • Use embeds
  • Upload files and images
  • Create and send polls

🚀 Usage

Import and setup

from simplehook import SimpleHook # or from simplehook import SimpleHookAsync

# Initialize with your webhook URL
hook = SimpleHook("https://discord.com/api/webhooks/your_webhook_url")
# or
hook = SimpleHookAsync("https://discord.com/api/webhooks/your_webhook_url")

Core functions

# Send a simple message
hook.send_message("Hello, world!")

# Send a file
hook.send_file("example.txt")

# Send a message with a custom username, avatar, and text-to-speech
hook.send_customized_message(
    message="I'm a bot!",
    username="CoolBot",
    avatar_url="https://i.imgur.com/your_avatar.png",
    tts=True
)

# Mention a user by ID or everyone/here
hook.send_customized_message(message="Look here!", mention="123456789012345678")  # user mention
hook.send_customized_message(message="Attention!", mention="everyone")  # @everyone

Embed functions

# Send embedded files (max 10)
hook.send_embedded_files(paths=["img1.png", "img2.jpg"], message="Check these out!", color=53231)

# Send embedded message
hook.send_embedded_message(title="Hello!", color=321)

# Send embedded author message
hook.send_embedded_author(name="Paul", avatar_url="https://i.imgur.com/your_avatar.png")

# Send embedded URL with a custom title
hook.send_embedded_url(title="Google!", url="https://www.google.com")

# Send embedded image from the web
hook.send_embedded_url_image(url="https://i.imgur.com/your_image.png")

# Send embed message with multiple fields
hook.send_embedded_field(names=["Username", "Score"], values=["Player", "150"], inline=[True, True])

Poll function

# Create and send a poll
hook.create_poll(
    question="What's your favorite color?",
    answers=["Blue", "Red", "Green"],
    emojis=["🔵", "🔴", "🟢"],
    duration=48,
    allow_multiselect=True
)

📦 Installation

pip install simplehook

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

simplehook-1.4.2.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

simplehook-1.4.2-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file simplehook-1.4.2.tar.gz.

File metadata

  • Download URL: simplehook-1.4.2.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for simplehook-1.4.2.tar.gz
Algorithm Hash digest
SHA256 548fece9745fb6a8ed9e46f9f8bdb6ae33198961429f92eed7b6c26f6c671be6
MD5 b45331831e2fd76e097297a537f55897
BLAKE2b-256 126e0bd9d88d0e6b58ecdc2f434508dc7a66c6fc732f85bb28a975bd7e33f715

See more details on using hashes here.

File details

Details for the file simplehook-1.4.2-py3-none-any.whl.

File metadata

  • Download URL: simplehook-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for simplehook-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 03a87f75604eeadd3c194dcb192bbfd20b2f600785b4f8abe05c8766a7d2e6c6
MD5 75a030e1f76a73d5061be21a3d69dafa
BLAKE2b-256 d0df4a028c885af5c9990f9b75289929ce63a741a9975eab44205c388a4be63b

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