Skip to content

1.0.0
Compare
Choose a tag to compare
@dbrennand dbrennand released this 04 Jun 10:47
· 25 commits to master since this release
1.0.0
f80a7c4
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

1.0.0

This version includes an almost complete re-write of the bot. Updated for the latest pre-release version of the python-telegram-bot library. All other dependencies have also been updated.

This release includes breaking changes:

  • Docker is now the only supported method for using the bot.
  • The reader database is now located at /usr/src/app/reader in the container.

Migrating to 1.0.0

  1. Copy the db.sqlite file out of the container to your hosts current working directory:

    docker cp rss_feederbot:/usr/src/app/db.sqlite /path/to/store/db
ls -la /path/to/store/db/db.sqlite

  2. Once you've got a copy of your database, you can stop and remove the old container:

    docker stop rss_feederbot
docker rm rss_feederbot

  3. Pull the latest changes and build the new container image:

    git pull; docker build -t feederbot:1.0.0 .

  4. Start the new container and mount the directory containing the db.sqlite database:

    docker run -d -t -e BOT_TOKEN="<Bot Token>" -e USER_ID="<User ID>" -v /path/to/store/db:/usr/src/app/reader --name feederbot feederbot:1.0.0

If you experience any issues updating, please open an issue and I'll try my best to help you 🙂

Improvements

  • The bot now uses a far more efficient method for tracking when a feed has updated. Leveraging the reader libraries mark_entry_as_read method.
  • If a new feed is added since the last update, the bot can detect this and shows the 5 most recent feed entries. On the next update it will show newly added entries since the last update.
  • Added type hints.
  • Moved to Google docstring format.
  • Included emojis for success ✅ and failure ❌
  • Improved logging with bind() method to clarify where the bot is performing operations.
  • Multiple feeds can be added and removed at once.
  • Command names have been modified slightly. Supported commands are:
* `/addfeeds <url> ...` - Add feeds.

* `/removefeeds <url> ...` - Remove feeds.

* `/start <inverval>` - Start reading feeds.

* `/changeinterval <interval>` - Change the feed update interval.

* `/showfeeds` - Show feeds.

* `/showjob` - Show the datetime of the next feed update job.
  • Updated README.md with steps to persist the reader database across container restarts!

Full Changelog: https://github.com/dbrennand/RSS_Feederbot/commits/1.0.0

Assets 2
Loading