Matrix-Mirrors/maubot-rss
1
0
Fork 0
mirror of https://github.com/maubot/rss.git synced 2024-12-24 23:29:29 -05:00
Code Issues Packages Projects Releases Wiki Activity
A RSS plugin for maubot
70 Commits 1 Branch 11 Tags 324 KiB
Python 100%
master
Go to file
Tulir Asokan b58202ebfb
Merge pull request #35 from AndrewKvalheim/entry-id-fallback 
Stabilize entry IDs
2023-02-21 13:24:15 +02:00
.github/workflows Update and unpin black 2022-04-30 21:14:38 +03:00
rss Merge pull request #35 from AndrewKvalheim/entry-id-fallback 2023-02-21 13:24:15 +02:00
.gitignore Initial commit 2018-11-27 02:33:41 +02:00
.gitlab-ci.yml Move CI script to main maubot repo 2022-06-19 14:27:42 +03:00
.pre-commit-config.yaml Update and unpin black 2022-04-30 21:14:38 +03:00
base-config.yaml Make default notification template configurable 2022-03-26 14:45:07 +02:00
LICENSE Initial commit 2018-11-27 02:33:41 +02:00
maubot.yaml Bump version to 0.3.2 2022-10-03 09:25:35 +03:00
pyproject.toml Update and unpin black 2022-04-30 21:14:38 +03:00
README.md Add usage to readme 2023-02-21 12:47:13 +02:00

README.md

rss

A maubot that posts RSS feed updates to Matrix.

Usage

Basic commands:

  • !rss subscribe <url> - Subscribe the current room to a feed.
  • !rss unsubscribe <feed ID> - Unsubscribe the current room from a feed.
  • !rss subscriptions - List subscriptions (and feed IDs) in the current room.
  • !rss notice <feed ID> [true/false] - Set whether the bot should send new posts as m.notice (if false, they're sent as m.text).
  • !rss template <feed ID> [new template] - Change the post template for a feed in the current room. If the new template is omitted, the bot replies with the current template.

Templates

The default template is New post in $feed_title: [$title]($link).

Templates are interpreted as markdown with some simple variable substitution. The following variables are available:

  • $feed_url - The URL that was used to subscribe to the feed.
  • $feed_link - The home page of the feed.
  • $feed_title - The title of the feed.
  • $feed_subtitle - The subtitle of the feed.
  • $id - The unique ID of the entry.
  • $date - The date of the entry.
  • $title - The title of the entry.
  • $summary - The summary/description of the entry.
  • $link - The link of the entry.