TheLovinator/discord-rss-bot
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A RSS bot for Discord
625 commits 1 branch 0 tags 2 MiB
  • Python 77.7%
  • jinja 22%
  • Dockerfile 0.2%
Find a file
Joakim Hellsén 44f50a4a98
 Remove test for updating an existing feed
2025-05-17 04:07:13 +02:00
.gitea/workflows Replace GitHub Actions build workflow with Gitea workflow 2025-05-04 04:08:39 +02:00
.github Replace GitHub Actions build workflow with Gitea workflow 2025-05-04 04:08:39 +02:00
.vscode Update Docker healthcheck 2025-05-04 05:28:37 +02:00
discord_rss_bot Add button for manually updating feed 2025-05-17 03:58:08 +02:00
tests Remove test for updating an existing feed 2025-05-17 04:07:13 +02:00
.gitattributes Add .gitattributes to set Jinja as the language for HTML files 2025-04-01 22:58:42 +02:00
.gitignore Update .gitignore 2025-02-10 04:33:12 +01:00
.pre-commit-config.yaml Update ruff-pre-commit to version 0.11.8 2025-05-03 19:42:20 +02:00
docker-compose.yml Update Docker healthcheck 2025-05-04 05:28:37 +02:00
Dockerfile Update Docker healthcheck 2025-05-04 05:28:37 +02:00
LICENSE Initial commit 2021-12-11 23:32:40 +01:00
pyproject.toml Add tldextract for improved domain extraction and add new tests for extract_domain function 2025-04-16 13:32:31 +02:00
README.md Add Hoyolab API integration 2025-05-04 03:48:22 +02:00
requirements.txt Integrate Sentry for error tracking and performance monitoring 2025-02-10 04:56:55 +01:00

README.md

discord-rss-bot

Subscribe to RSS feeds and get updates to a Discord webhook.

Features

  • Subscribe to RSS feeds and get updates to a Discord webhook.
  • Web interface to manage subscriptions.
  • Customizable message format for each feed.
  • Choose between Discord embed or plain text.
  • Regex filters for RSS feeds.
  • Blacklist/whitelist words in the title/description/author/etc.
  • Gets extra information from APIs if available, currently for:

Installation

You have two choices, using Docker or install directly on your computer.

Docker

  • Open a terminal in the repository folder.
    • Windows 10: Shift + right-click in the folder and select Open PowerShell window here
    • Windows 11: Shift + right-click in the folder and Show more options and Open PowerShell window here
  • Run the Docker Compose file:
    • docker-compose up
      • You can stop the bot with Ctrl + c.
      • If you want to run the bot in the background, you can run docker-compose up -d.
  • You should run this bot behind a reverse proxy like Caddy or Nginx.
    • 5000 is the port the bot listens on.
  • You can update the container with docker-compose pull

Install directly on your computer

This is not recommended if you don't have an init system (e.g., systemd)

  • Install the latest version of needed software:
    • Python
      • You should use the latest version.
      • You want to add Python to your PATH.
      • Windows: Find App execution aliases and disable python.exe and python3.exe
    • Poetry
      • Windows: You have to add %appdata%\Python\Scripts to your PATH for Poetry to work.
  • Download the project from GitHub with Git or download the ZIP.
    • If you want to update the bot, you can run git pull in the project folder or download the ZIP again.
  • Open a terminal in the repository folder.
    • Windows 10: Shift + right-click in the folder and select Open PowerShell window here
    • Windows 11: Shift + right-click in the folder and Show more options and Open PowerShell window here
  • Install requirements:
    • Type poetry install into the PowerShell window. Make sure you are in the repository folder where the pyproject.toml file is located.
      • (You may have to restart your terminal if it can't find the poetry command. Also double check it is in your PATH.)
  • Start the bot:
    • Type poetry run python discord_rss_bot/main.py into the PowerShell window.
      • You can stop the bot with Ctrl + c.

Note: You will need to run poetry install again if poetry.lock has been modified.

Contact

Email: mailto:tlovinator@gmail.com Discord: TheLovinator#9276