Easily using discord webhooks in python - asynchronous and synchronous - documented at https://discordwebhook.readthedocs.io/en/latest/
Project description
discordwebhook.py
A python package for using discord webhooks. The only with asynchronous and synchronous options and fetching webhook information. A lightweight alternative to a full Discord API wrapper, just for webhooks.
For documentation see the readthedocs page For downloads see the PyPi page
For extra support join the Discord server
Installation
pip install discordwebhook.py
Examples
Basic example
import discordwebhook
# Create the webhook.
webhook = discordwebhook.Webhook(
url="webhook_url"
)
# Add embed with title "Embed title", same as discord.py
embed = discordwebhook.Embed(
title="Embed title",
)
# Add a field to the embed, exactly the same as discord.py
embed.add_field(name="Field title", value="Exact same as discord.py, however is lighter", inline=False)
# Post webhook to URL synchronously. Can be await webhook.send_async to send asynchronously
webhook.send_sync(
f"This is the message content!", # Webhook message content
username="Coolo2", # Overwrite webhook username, can also be defined when class is initialized
embed=embed # Embeds can also be set with embeds=[embed]
)
Fetch example
import discordwebhook
webhook = discordwebhook.Webhook(
url="webhook_url"
)
# Can be used synchronously and asynchronously with fetch_data_async. Returns current Webhook class
webhook.fetch_data_sync()
print(webhook.id)
print(webhook.url)
print(webhook.name)
print(webhook.icon_url)
print(webhook.channel_id)
print(webhook.guild_id)
Editing and deleting messages example
import discordwebhook
import time
# Initialise the webhook object.
webhook = discordwebhook.Webhook(
url="webhook_url"
)
# Send a message to the webhook
message = webhook.send_sync(
content="The message content goes here"
)
time.sleep(1) # wait 1 second before editing
# Edit the message with new content, but keep the embed (as it is left empty)
message.edit_sync(
content="New message content! It has been 1 second since the webhook was sent"
)
time.sleep(5) # wait 5 seconds before deleting
message.delete_sync()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file discordwebhook.py-1.1.2.tar.gz
.
File metadata
- Download URL: discordwebhook.py-1.1.2.tar.gz
- Upload date:
- Size: 9.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb9eb7eefccfe83545f18eb05d5c3fffd4923e99624d6a84f7f12613a4fb842d |
|
MD5 | 58bee1a70813ab0b7bd1202d11b39f24 |
|
BLAKE2b-256 | 53dc18f3d49fd366269c6ff043f394466e647aaacfa5e3e96dc787e0b55a87a4 |