Skip to main content

generate a rss feed from Twitter or Mastodon search

Project description

python-twootfeed

a Python script to generate a rss feed from parsed Twitter or Mastodon search and Mastodon favorites, using Flask.

Python Version Codacy Badge Coverage Status Build Status


The RSS feed displays only the original tweets (not the retweets) and :

  • links to :
    • the original tweet on Twitter or toot on Mastodon
    • hashtags
    • usernames
  • URLs
  • images
  • source
  • location (only for Twitter)
  • numbers of retweets (or boosts for Mastodon) and favorites
    (see examples below).

Requirements

  • Python 3.6+
  • API keys Twitter and/or Mastodon

Installation and configuration

  • Install from pip
$ pip install twootfeed
  • Initialize the configuration file
$ twootfeed_init
  • Fill in fields for the client(s) you will use in '~/.config/twootfeed/config.yml' :

    • for Twitter : see https://apps.twitter.com
      copy/paste the Twitter API key values in config.yml file ('consumerKey' and 'consumerSecret')
    • for Mastodon : see Python wrapper for the Mastodon API
      use the included script which will register your app and prompt you to log in, creating the credential files for you.
    $ twootfeed_create_mastodon_cli
    
  • Start the app

$ twootfeed

Usage

The RSS feeds are available on these urls:

Examples

Search on Twitter

Twitter search

Results in RSS Feed:
RSS Feed

Display on FreshRSS, a great free self-hosted aggregator (https://github.com/FreshRSS/FreshRSS):
FreshRSS

Search on Mastodon

Mastodon search

Results in RSS Feed:
Mastodon Feed

Display on FreshRSS:
Mastodon FreshRSS

Contribute

see Quick start for developers

Contributors

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

twootfeed-0.6.0.tar.gz (9.8 kB view hashes)

Uploaded Source

Built Distribution

twootfeed-0.6.0-py3-none-any.whl (12.2 kB view hashes)

Uploaded Python 3

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