Repository navigation
v1.0.0
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, andmypyfor code formatting and static type checking. - Testing: Unit tests using
pytestto ensure code reliability.
- Linting: Integrated with
- Development Environment: Managed using
poetryfor dependency management and packaging.
Installation and Usage
Docker
-
Build the Docker image:
make docker-build
-
Run the Docker container:
docker run --rm -e DISCORD_WEBHOOK_URL="<YOUR_WEBHOOK_URL>" -e DISCORD_MESSAGE="<YOUR_MESSAGE>" discord-webhook-sender
Local Development
-
Install dependencies:
poetry install
-
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.