julianorchard / rss-ntfy

Tiny Python 3 RSS reading script to get notifications (using ntfy) of posts on services like Proxitok and Nitter.

RSS ntfy

Very small RSS notifier using ntfy. I would highly recommend using a self hosted ntfy instance, so that you can use whatever ntfy names you want.

It's designed for use alongside certain 'alternative frontend services'. I use it for:

• Nitter, Twitter alternative
• Proxitok, a TikTok frontend

Both of these provide RSS feeds, which are on basically every page plus /rss: very handy.

Usage

Dependencies

• Python 3
• BeautifulSoup4, pip install beautifulsoup4
• requests python -m pip install requests
• lxml-xml parser for BeautifulSoup

pip install -i requirements.txt

Alternatively, use Docker compose:

docker compose up

This will create a persistent volume for the storage of the _hist files, too (if run without Docker, these are put in $XDG_CACHE_HOME).

Configuration

Edit the config.yaml file:

# Example configuration
---

proxitok:
  service: proxitok
  rss-url: https://proxitok.pabloferreiro.es/@{{ user }}/rss
  descriptor: 🎶 TikTok

teddit:
  service: teddit
  rss-url: https://teddit.net/r/{{ sub }}?api&type=rss
  descriptor: 🎩 Reddit post

At this point the contents of the handlebar type substitutions ({{ }}) don't matter; this will be replaced with the users/subreddits/thing-you-want-to-follow in the files in the rss-ntfy/ folder.

TODO: this is a not-nice way of doing this, possibly use more yaml

You can then use a crontab or a systemd service (or, on Windows, a Task Scheduler task) to run the command periodically.

License

Under the MIT License. See license file for more information.