Skip to main content

A modern, type-hinted Python library for seamless interaction with the Discord Webhook API.

Project description

Clyde

Python GitHub Workflow Status PyPI Downloads Coverage Report

Clyde is a modern, type-hinted Python library for seamless interaction with the Discord Webhook API.

It's lightweight, developer-friendly, and supports advanced features like Components and Embeds.

Features

  • Fully type-hinted for an excellent developer experience
  • Input validation powered by Pydantic
  • Support for all Webhook-compatible Components
  • Granular customization of rich Embeds
  • Helpers for Discord-flavored markdown, including timestamps
  • Compatible with both synchronous and asynchronous HTTP requests

Getting Started

Installation

[!IMPORTANT] Clyde requires Python 3.13 or later.

Install with uv (recommended):

uv add discord-clyde

Alternatively, install with pip:

pip install discord-clyde

Examples

[!TIP] Take the examples below and copy/paste them into your project to get started in seconds.

Send a standard Message

from clyde import Webhook

relay: Webhook = Webhook(url="https://discord.com/api/webhooks/00000/XXXXXXXXXX")

relay.set_avatar_url("https://i.imgur.com/RzkhQgZ.png")
relay.set_username("Heisenberg")

relay.set_content("[Clyde](https://github.com/EthanC/Clyde) says hi!")

relay.execute()

Preview

Send a Message with Components

from clyde import Webhook
from clyde.components import ActionRow, LinkButton, TextDisplay

relay: Webhook = Webhook(url="https://discord.com/api/webhooks/00000/XXXXXXXXXX")

relay.set_avatar_url("https://i.imgur.com/BpcKmVO.png")
relay.set_username("TARS")

greeting: TextDisplay = TextDisplay(content="[Clyde](https://github.com/EthanC/Clyde) says hi!")

actions: ActionRow = ActionRow()
repository: LinkButton = LinkButton()

repository.set_label("Try Clyde")
repository.set_url("https://github.com/EthanC/Clyde")

actions.add_component(repository)
relay.add_component(greeting)
relay.add_component(actions)
relay.execute()

Preview

Send a Message with an Embed

from clyde import Embed, Webhook


relay: Webhook = Webhook(url="https://discord.com/api/webhooks/00000/XXXXXXXXXX")

relay.set_avatar_url("https://i.imgur.com/QaTHttz.png")
relay.set_username("Shady")

rich: Embed = Embed()

rich.set_description("[Clyde](https://github.com/EthanC/Clyde) says hi!")
rich.set_color("#5865F2")

relay.add_embed(rich)
relay.execute()

Preview

Releases

Clyde loosely follows Semantic Versioning for consistent, predictable releases.

Contributing

Contributions are welcome—whether it’s fixing bugs or adding new features.

Acknowledgements

The Clyde character and Discord brand assets are owned by Discord.

This project is not affiliated with or endorsed by Discord in any way.

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

discord_clyde-0.2.0.tar.gz (7.1 MB view details)

Uploaded Source

Built Distribution

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

discord_clyde-0.2.0-py3-none-any.whl (39.3 kB view details)

Uploaded Python 3

File details

Details for the file discord_clyde-0.2.0.tar.gz.

File metadata

  • Download URL: discord_clyde-0.2.0.tar.gz
  • Upload date:
  • Size: 7.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for discord_clyde-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2483b65f6ffa1989500a61a433fef3ac64e8778af1fc0cd9fc1568c13173f493
MD5 b7736c60f5dd4d8203ed2d0ba98b206c
BLAKE2b-256 1152605975de0070490472becc47fb7ba00b0ee5c2165576c861287da5e45c19

See more details on using hashes here.

File details

Details for the file discord_clyde-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for discord_clyde-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45aa7cbb8b0c13883853df00ab8fcf11210a9ea1887c4261d34db86e2e382e99
MD5 5f907903d6167c3d98a081c9bc104cb8
BLAKE2b-256 19c8bc38161672da57ce2c6a65441444eec1068d53953e713134cc56c5a8701e

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