Skip to content

ping13/star-collector

Repository files navigation

Star Collector

A tool to generate an RSS feed combining your starred/favorite content from Mastodon favorites and/or bookmarks and any perosnalized RSS feed you may have (for example Feedbin or Linkding or even GitHub)

Features

  • Combines multiple star sources into a single RSS feed
  • Configurable number of items per feed
  • Support for Mastodon media attachments in feed items
  • Environment variable support for sensitive tokens
  • Detailed logging options

Installation

  1. Clone this repository
  2. Install dependencies (using pip or your preferred package manager)
  3. Copy .env.sample to .env and configure your tokens
  4. Create a sc_config.yaml (see below) and configure your settings

Configuration

Create a sc_config.yaml file with your settings:

mastodon:
  access_token: "your-token-here"  # Can also be set via MASTODON_ACCESS_TOKEN env var
  mastodon_instance: "https://your.instance"
  mastodon_username: "yourusername"

# Optional RSS configuration
rss:
  urls:
    - url: https://feedbin.com/starred/${FEEDBIN_ID}.xml
      tag: feedbin
    - url: https://bookmarks.ping13.net/feeds/${LINKDING_ID}/all
      tag: linkding

Usage

# Basic usage (outputs to stdout)
python rss.py

# With options
python rss.py --config sc_config.yaml --output feed.xml --limit 10 --debug

Options:
  -c, --config TEXT                 Path to configuration file (default: sc_config.yaml)
  --debug / --no-debug              Enable debug output
  -o, --output TEXT                 Output file (optional, defaults to stdout)
  -l, --limit INTEGER               Number of feed items to include (default: 5)
  -L, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                    Set logging level (default: ERROR)
  --help                            Show this message and exit

Ideas

Limitations

  • Currently, there is no way to use the creation date of a like in Mastodon, see this issue.

About

RSS feed for personal favourites and bookmarks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published