cybernetic
/
RSS-to-Telegram-Bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A Telegram RSS bot that cares about your reading experience
915 Commits 3 Branches 8 Tags 6.1 MiB
Python 99.1%
Dockerfile 0.9%
Go to file
dependabot[bot] fdc872eb73
build(deps): Bump apscheduler from 3.9.1 to 3.9.1.post1 (#208) 
Bumps [apscheduler](https://github.com/agronholm/apscheduler) from 3.9.1 to 3.9.1.post1.
- [Release notes](https://github.com/agronholm/apscheduler/releases)
- [Changelog](https://github.com/agronholm/apscheduler/blob/master/docs/versionhistory.rst)
- [Commits](https://github.com/agronholm/apscheduler/compare/3.9.1...3.9.1.post1)

---
updated-dependencies:
- dependency-name: apscheduler
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 		2022-11-15 09:04:19 +08:00
.github Add CodeQL workflow for GitHub code scanning (#206) 2022-11-12 00:17:40 +08:00
docs docs(*): update performance info 2022-11-03 19:11:46 +08:00
src fix(parsing): WEBP unnecessarily converted to PNG 2022-11-13 23:46:33 +08:00
.editorconfig chore(style): add `.editorconfig` 2022-04-21 00:58:31 +08:00
.env.sample chore(*): disable multiprocessing by default 2022-06-14 23:17:35 +08:00
.gitattributes Initial commit 2018-10-01 11:55:26 +02:00
.gitignore chore: simplify .gitignore 2022-08-01 12:13:41 +08:00
Dockerfile build(Dockerfile): build static-linked lxml on arm 2022-11-05 23:25:24 +08:00
LICENSE Change the license to AGPL 2021-09-06 05:30:35 +08:00
Procfile build: add heroku support 2022-03-16 16:23:37 +08:00
README.md docs(*): update performance info 2022-11-03 19:11:46 +08:00
README.zh.md docs(*): update performance info 2022-11-03 19:11:46 +08:00
app.json build: add heroku support 2022-03-16 16:23:37 +08:00
docker-compose.yml.sample chore(docker-compose.yml.sample): default to dev 2022-10-18 16:24:37 +08:00
pyproject.toml chore(*): ready for packaging 2022-03-31 03:31:13 +08:00
requirements.txt build(deps): Bump apscheduler from 3.9.1 to 3.9.1.post1 (#208) 2022-11-15 09:04:19 +08:00
setup.cfg chore(*): ready for packaging 2022-03-31 03:31:13 +08:00
setup.py feat(*): add shebang to *.py in project root 2022-08-01 12:01:00 +08:00
telegramRSSbot.py feat(*): add shebang to *.py in project root 2022-08-01 12:01:00 +08:00

README.md

RSStT icon

RSS to Telegram Bot

A Telegram RSS bot that cares about your reading experience

简体中文 README

GitHub commit activity Translating status Code quality GitHub stars GitHub forks

Telegram bot Telegram group Telegram channel

CHANGELOG FAQ Documentation Channels Using RSStT

Important: If you have your own RSStT bot (v1), please read the migration guide to learn how to migrate to v2.

Highlights

  • Multi-user
  • I18n
    • English, Chinese, Cantonese, Italian, and more!
  • The content of the posts of an RSS feed will be sent to Telegram
    • Keep rich-text format
    • Keep media (customizable)
      • Images, Videos, and Audio both in the post content and enclosure; Documents in the post enclosure
      • Long images will be sent as files to prevent Telegram from compressing the image and making it unreadable
      • Drop annoying icons, they break the reading experience
    • Automatically replace emoji shortcodes with emoji
    • Automatically replace emoji images with emoji or its description text
    • Automatically determine whether the title of the RSS feed is auto-filled, if so, omit the title (customizable)
    • Automatically show the author-name (customizable)
    • Automatically split too-long messages
      • If configured Telegraph, the message will be sent via Telegraph (customizable)
  • Various customizable formatting settings
    • Hashtags, custom title, etc.
  • Individual proxy settings for Telegram and RSS feeds
  • OPML importing and exporting (keep custom title)
  • Optimized performance (see also the FAQ)
  • User-friendly
  • HTTP Caching

Deployment

PyPI PyPI publish status PyPI - Downloads PyPI - Python Version

Docker Image Size (tag) Build status (master) Build status (dev) Docker pulls

It is quite easy to deploy your RSStT instance. The most recommended way to deploy RSStT is Docker Compose: it is suitable for virtually all VPS. Railway.app (a PaaS platform) is also officially supported. You may also install RSStT from PyPI using pip, but it only follows the master branch instead of the dev branch. For developers or experienced users, dirty run from source is also an option.

Deploy on Railway

For more details, refer to the deployment guide.

Translation

Read the translation guide here.

You can help to translate the bot using Hosted Weblate. Special thanks to their free hosting service for libre projects!

Using the public bot

The public bot comes with absolutely no warranty. I will try my best to maintain it, but I cannot guarantee that it will always work perfectly. Meanwhile, you should "fair use" the bot, avoid subscribing to too many RSS feeds.
If you use the public bot in your Channel, consider mentioning the bot (or this project) in your channel description (or pinned message) to let more people know about it. That's not a compulsion.

Known channels using RSStT

Want to preview what the messages sent by RSStT look like? Here is a list of channels using RSStT.

License

This project is licensed under AGPLv3. Closed-source distribution or bot-hosting are strictly prohibited. If you modify the code and distribute or host it, make sure any users who can use your bot can get the source code (by editing the repo URL in src/i18n/__init__.py).

The repository was formerly a fork of BoKKeR/RSS-to-Telegram-Bot. They have been entirely different projects since the early days of this project.