Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbrennand/Feederbot
An Atom, RSS, and JSON feed reading Telegram bot 🤖
https://github.com/dbrennand/Feederbot
atom bot feed json reading-rss-feeds rss rss-aggregator rss-feed rss-feederbot rss-reader telegram telegram-bot
Last synced: about 1 month ago
JSON representation
An Atom, RSS, and JSON feed reading Telegram bot 🤖
- Host: GitHub
- URL: https://github.com/dbrennand/Feederbot
- Owner: dbrennand
- License: mit
- Created: 2018-11-26T19:29:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T17:47:35.000Z (4 months ago)
- Last Synced: 2024-06-28T17:40:54.079Z (3 months ago)
- Topics: atom, bot, feed, json, reading-rss-feeds, rss, rss-aggregator, rss-feed, rss-feederbot, rss-reader, telegram, telegram-bot
- Language: Python
- Homepage:
- Size: 90.8 KB
- Stars: 24
- Watchers: 1
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Feederbot
An Atom, RSS, and JSON feed reading Telegram bot 🤖
Feederbot checks on a user configurable interval for feed updates.
## Prerequisites
1. A Telegram bot token from [@BotFather](https://t.me/botfather)
2. Your Telegram user ID from [@userinfobot](https://t.me/userinfobot)
3. Docker
## Supported Commands
* `/addfeeds ...` - Add feeds.
* `/removefeeds ...` - Remove feeds.
* `/start ` - Start reading feeds.
* `/changeinterval ` - Change the feed update interval.
* `/showfeeds` - Show feeds.
* `/showjob` - Show the datetime of the next feed update job.
## Setup
1. Build the container image:
```bash
# Using docker-compose
docker-compose build
# Using docker build
docker build -t feederbot:1.0.1 .
```
2. Run the container:
```bash
# Using docker-compose
# Supply the BOT_TOKEN and USER_ID environment variables in docker-compose.yml
docker-compose up -d
# Using the Docker volume for the reader database
docker run -d -t -e BOT_TOKEN="" -e USER_ID="" --name feederbot feederbot:1.0.1
# Using a bind mount for the reader database
docker run -d -t -e BOT_TOKEN="" -e USER_ID="" -v /path/to/store/db:/usr/src/app/reader --name feederbot feederbot:1.0.1
```
## Authors -- Contributors
[**dbrennand**](https://github.com/dbrennand) - *Author*
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) for details.