Skip to content

v1.0.0

Choose a tag to compare

@caiolombello caiolombello released this 06 Jun 20:31
· 2 commits to main since this release
84dffc3

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.