Skip to main content

generate a rss feed from Twitter or Mastodon search

Project description

python-twootfeed

generate a rss feed from parsed Twitter or Mastodon search and Mastodon favorites

Python Version Codacy Badge Coverage Status Build Status


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

  • links to :
    • the tweet on Twitter or toot on Mastodon
    • hashtags
    • usernames
  • URLs
  • images
  • source
  • location (only for Twitter)
  • numbers of retweets and likes for tweets and boosts and favourites for toots
    (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
    

    Update the feed and app parameters.

  • The files location can be changed with the following environment variables:

variable description app default value
TWOOTFEED_CONFIG_DIR configuration and credentials files directory '~/.config/twootfeed/'
TWOOTFEED_CONFIG_FILE config file full path config dir + 'config.yml' => with default value: '~/.config/twootfeed/config.yml'
TWOOTFEED_LOG application log file no default value (log printed on the console)
  • 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

Thanks to:

  • georgedorn for adding:
    • rss feed generation with authenticated user's favorites
    • script to register the app and generate credentials for Mastodon

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
twootfeed-0.6.2-py3-none-any.whl (13.2 kB) Copy SHA256 hash SHA256 Wheel py3
twootfeed-0.6.2.tar.gz (11.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page