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)
      • Most images and videos will be uploaded to Telegraph, so that Instant View will load rapidly
  • 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.

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.

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.7.0.tar.gz (203.8 kB view details)

Uploaded Source

Built Distribution

rsstt-2.7.0-py3-none-any.whl (255.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rsstt-2.7.0.tar.gz
  • Upload date:
  • Size: 203.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for rsstt-2.7.0.tar.gz
Algorithm Hash digest
SHA256 9e270903efbc4311d7724bb5243bcc22757d872b87fd97acd3cd20332752ab92
MD5 9f4693479d57db971ecf243742e473a6
BLAKE2b-256 e47b1d579ce9ea3c3e3f39787bae85f4884ff31940bb7835000e057f0623620c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rsstt-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 255.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for rsstt-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 282f62cf9bf50da6439eeb788858eabdfdee8f3db0dc79da00569dc69e76101f
MD5 f12ff8ae877efaec3a4c516a26f60037
BLAKE2b-256 3d06047c225d8790ddadc326297e9b15518cb0b3d1f4c9a4873c5f44dea6ef7c

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