https://github.com/droidzed/disco-hooker

Discord Webhook backend notifier.
https://github.com/droidzed/disco-hooker

discord flask python webhook

Last synced: 18 days ago
JSON representation

Discord Webhook backend notifier.

• Host: GitHub
• URL: https://github.com/droidzed/disco-hooker
• Owner: DroidZed
• License: mit
• Created: 2023-11-07T20:53:59.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-09T16:00:40.000Z (3 months ago)
• Last Synced: 2024-10-10T06:54:02.001Z (30 days ago)
• Topics: discord, flask, python, webhook
• Language: Python
• Homepage:
• Size: 152 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Disco Hooker


[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://pypi.org/project/leafengine/)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)

[![Docker Image CI](https://github.com/DroidZed/disco-hooker/actions/workflows/docker-image.yml/badge.svg)](https://github.com/DroidZed/disco-hooker/actions/workflows/docker-image.yml)





## Intro

Thi is a simple Discord Hook notifier backend written in `flask` & `discord-webhook`.

![Example](/images/example.png)

THIS PROJECT USES PYTHON TYPE HINTING FEATURES SO A VERSION OF PYTHON >= 3.10 IS ADVISED !

## Usage:

1. Docker image:

   a. Pull the image:

   ```sh

   docker pull droidzed/disco-hooker:latest

   ```

   b. Run the container:

   ```sh

   docker run -d -p 6000:6000 -e PORT=6000 -e WEBHOOK_URL=YOUR_DISCORD_WEBHOOK_URL droidzed/disco-hooker:latest

   ```

2. Run locally:

   a. Clone the repo:

   ```sh

   git clone https://github.com/DroidZed/disco-hooker.git

   ```

   b. Install deps:

   ```sh

   pipenv install

   ```

   c. Create `.env` file like so:

   
Make sure to fill in the required variables !

   ![env](./images/env.png)

   d. Run:

   ```sh

   py app.py

   ```

3. API Request:

   ![API Request](/images/request.png)



## Useful links:

[Discord Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)


[Discord Webhooks & Safety](https://discord.com/safety/using-webhooks-and-embeds)