Skip to main content

A Telegram RSS bot that cares about your reading experience

Project description

RSS to Telegram Bot

RSS to Telegram Bot

A Telegram RSS bot that cares about your reading experience

GitHub commit activity Translating status Code quality GitHub stars GitHub forks

Telegram bot Telegram group Telegram channel

简体中文 README CHANGELOG FAQ Documentation Channels Using RSStT
Screenshot Screenshot Screenshot
Screenshot

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
    • Messages can be sent as Telegraph posts (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

dockeri.co
Build status (master) Build status (dev)

PyPI TestPyPI PyPI - Python Version
PyPI publish status TestPyPI publish status PyPI - Downloads

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 (tracking master branch) or TestPyPI (tracking dev branch, which is always up-to-date) using pip. 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.

Licensing

AGPLv3 logo

This project is licensed under AGPLv3+. Closed-source distribution or bot-hosting are strictly prohibited. If you distribute or host it with code modifications, make sure the source code is available to anyone who can use the bot (by editing the repo URL in src/i18n/__init__.py).

RSS to Telegram Bot
Copyright (C) 2020-2024  Rongrong <i@rong.moe>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

The repository was forked from BoKKeR/RSS-to-Telegram-Bot in 2020. Since some time in 2021, they share no common codebase and should be considered as completely different projects.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rsstt-2.9.0.tar.gz (223.3 kB view details)

Uploaded Source

Built Distribution

rsstt-2.9.0-py3-none-any.whl (310.8 kB view details)

Uploaded Python 3

File details

Details for the file rsstt-2.9.0.tar.gz.

File metadata

  • Download URL: rsstt-2.9.0.tar.gz
  • Upload date:
  • Size: 223.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for rsstt-2.9.0.tar.gz
Algorithm Hash digest
SHA256 72628638c0430c736d3f3b580be9eb6fd2c178eb531817d000ced6718dc0cd00
MD5 6ff5ed816b04bb641f73058268e8368f
BLAKE2b-256 5bdc35ee4c40e0f525620fe56eec52c2d8ffedeb4d83e88a9ade1461647b2114

See more details on using hashes here.

File details

Details for the file rsstt-2.9.0-py3-none-any.whl.

File metadata

  • Download URL: rsstt-2.9.0-py3-none-any.whl
  • Upload date:
  • Size: 310.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for rsstt-2.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 071c7c4218d87464dc2f03eed4408565ef170ccb0577997b070ae324f5da41b6
MD5 b6847d489bdb75b223df29d60e8d64d5
BLAKE2b-256 dc41672e056d0901d52e269040e16f5562b34e63d8c4aa4082d067530e2b34bb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page