Kumi
7c8d957548
Added support for configurable event types for sending messages, enabling use of either "text" or "notice" message types as per user preference. Additionally, this update brings along improvements including code cleanup, updated dependencies to improve functionality and fix potential security issues, and reorganization of example configuration files into a more structured directory. Significant refactorings standardize async task creations and remove unused imports, streamlining the codebase for better maintainability and performance. - Introduced `EventType` in `config.dist.ini` to allow users to specify the desired event type for outbound messages. - Upgraded dependency versions in `pyproject.toml`, adding `future` for forward compatibility. - Removed the deprecated `rssbot-pantalaimon.service` and unused image/file send functions in `bot.py`, focusing on core functionalities. - Reorganized `pantalaimon.example.conf` into `contrib` directory for better project structure. - Simplified logging and callback handling, removing redundant code paths and improving code readability. - Bumped project version to 0.1.2, paving the way for new features and fixes. This enhancement is aimed at providing users with greater flexibility in how messages are sent, accommodating different use cases and preferences. |
||
|---|---|---|
| .github | ||
| contrib | ||
| src/matrix_rssbot | ||
| .gitignore | ||
| config.dist.ini | ||
| LICENSE | ||
| pantalaimon_first_login.py | ||
| pyproject.toml | ||
| README.md | ||
| rssbot.service | ||
Matrix-RSSBot
This is a simple, no-database RSS/Atom feed bot for Matrix. It is designed to be easy to use and lightweight.
Installation
pip install matrix-rssbot
Create a configuration file in config.ini based on the config.dist.ini provided in the repository.
At the very least, you need to provide the following configuration:
[Matrix]
Homeserver = http://your-homeserver.example.com
AccessToken = syt_YourAccessTokenHere
We recommend using pantalaimon as a proxy, because the bot itself does not support end-to-end encryption.
You can start the bot by running:
rssbot
Usage
The bot will automatically join all rooms it is invited to.
You have to ensure that the bot has the necessary permissions to send state events and messages in the room. Regular users cannot send state events, so you have to either raise the bot user's power level (Moderator level should do) or lower the power level required to send state events.
You can now add a feed to the bot by sending a message to the bot in the room you want the feed to be posted in. The message should be in the following format:
!rssbot addfeed https://example.com/feed.xml
To list all feeds in a room, you can use the following command:
!rssbot listfeeds
Finally, to remove a feed, you can use the following command:
!rssbot removefeed https://example.com/feed.xml
Alternatively, you can use the number of the feed in the list, which you can get by using the listfeeds command instead of the URL.
License
This project is licensed under the MIT License - see the LICENSE file for details.