Skip to content

Releases: caiolombello/DiscordWebhookSender

Release list

v1.1.0

v1.1.0 Latest
Latest

Choose a tag to compare

View all tags
@caiolombello caiolombello released this 07 Jun 13:02
v1.1.0
3fa640b
This commit was signed with the committer’s verified signature.
Verified
Learn about vigilant mode.

Overview

This release introduces support for Discord embeds, allowing users to send richer messages with additional customizations.

New Features

  • Embed Support: You can now include embeds in your Discord messages.
    • Title: Add a title to your embed using the DISCORD_EMBED_TITLE environment variable.
    • Description: Add a description to your embed using the DISCORD_EMBED_DESCRIPTION environment variable.
    • Color: Customize the embed color using the DISCORD_EMBED_COLOR environment variable (in hexadecimal format without #).

Enhancements

  • Environment Variables: Updated to include optional variables for embed customization.
  • Documentation:
    • Added instructions and examples for sending simple messages and messages with embeds.
    • Updated environment variable list to include embed options.
  • Testing:
    • Added unit tests to cover new embed functionality.

How to Use

For a simple message:

docker run --rm \
  -e DISCORD_WEBHOOK_URL="<YOUR_WEBHOOK_URL>" \
  -e DISCORD_MESSAGE="<YOUR_MESSAGE>" \
  discord-webhook-sender

For a message with embed:

docker run --rm \
  -e DISCORD_WEBHOOK_URL="<YOUR_WEBHOOK_URL>" \
  -e DISCORD_MESSAGE="<YOUR_MESSAGE>" \
  -e DISCORD_EMBED_TITLE="<YOUR_EMBED_TITLE>" \
  -e DISCORD_EMBED_DESCRIPTION="<YOUR_EMBED_DESCRIPTION>" \
  -e DISCORD_EMBED_COLOR="<YOUR_EMBED_COLOR>" \
  discord-webhook-sender

Environment Variables

  • DISCORD_WEBHOOK_URL: The URL of the Discord webhook.
  • DISCORD_MESSAGE: The message to be sent.
  • DISCORD_EMBED_TITLE: The title of the embed (optional).
  • DISCORD_EMBED_DESCRIPTION: The description of the embed (optional).
  • DISCORD_EMBED_COLOR: The color of the embed in hexadecimal format without # (optional).

Contribution

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Assets 2
Loading

v1.0.0

v1.0.0

Choose a tag to compare

View all tags
@caiolombello caiolombello released this 06 Jun 20:31
v1.0.0
84dffc3
This commit was signed with the committer’s verified signature.
Verified
Learn about vigilant mode.

Overview

This is the initial release of DiscordWebhookSender, a tool designed to send messages to a Discord webhook using Python and Docker. This release includes all the core features and functionality necessary for deploying and running the application.

Features

  • Webhook Messaging: Send messages to a specified Discord webhook URL.
  • Dockerized: Containerized using Docker for easy deployment and consistent environments.
  • CI/CD Integration: Automated build and push of Docker images to DockerHub using GitHub Actions.
  • Code Quality Tools:
    • Linting: Integrated with black, ruff, and mypy for code formatting and static type checking.
    • Testing: Unit tests using pytest to ensure code reliability.
  • Development Environment: Managed using poetry for dependency management and packaging.

Installation and Usage

Docker

  1. Build the Docker image:

    make docker-build

  2. Run the Docker container:

    docker run --rm -e DISCORD_WEBHOOK_URL="<YOUR_WEBHOOK_URL>" -e DISCORD_MESSAGE="<YOUR_MESSAGE>" discord-webhook-sender

Local Development

  1. Install dependencies:

    poetry install

  2. Run tests:

    poetry run make test

Environment Variables

  • DISCORD_WEBHOOK_URL: The URL of the Discord webhook.
  • DISCORD_MESSAGE: The message to be sent.

Contribution

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Loading