Skip to main content

RSS/Atom headline widget for led-ticker (rss.feed).

Project description

led-ticker-rss

An RSS/Atom headline plugin for led-ticker. It contributes a single rss.feed widget that polls a feed URL and scrolls each story headline across the panel as its own ticker message.

This package split out of led-ticker-feeds (its feeds.rss widget); the type is now rss.feed.

Prerequisites

  • A working led-ticker install.
  • Internet access on the Pi (the widget fetches the feed URL).

Install

The widget auto-registers via the led_ticker.plugins entry point — once the package is installed, no [plugins] config change is needed.

Into a containerized led-ticker (recommended): add this package to config/requirements-plugins.txt (copy it from config/requirements-plugins.example.txt), then rebuild:

git+https://github.com/JamesAwesome/led-ticker-plugins.git@rss-v0.2.0#subdirectory=plugins/rss
# in your led-ticker checkout
docker compose up -d --build

Standalone (a venv that already has led-ticker):

pip install "git+https://github.com/JamesAwesome/led-ticker-plugins.git@rss-v0.2.0#subdirectory=plugins/rss"

led-ticker isn't on PyPI, so this path only works where led-ticker is already installed. See the led-ticker Plugins docs for the constraint-based install the Docker image uses.

Configuration

[[sections]]
[[sections.widgets]]
type = "rss.feed"
url = "https://feeds.bbci.co.uk/news/rss.xml"

The widget is a Container: it pulls the feed in the background and expands each story into its own scrolling TickerMessage, so live updates surface within one display cycle.

Development

This package lives in the led-ticker-plugins monorepo. Run tooling from the repo root:

uv sync --extra dev
uv run pytest plugins/rss
uv run ruff check plugins/rss

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

led_ticker_rss-0.2.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

led_ticker_rss-0.2.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file led_ticker_rss-0.2.0.tar.gz.

File metadata

  • Download URL: led_ticker_rss-0.2.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for led_ticker_rss-0.2.0.tar.gz
Algorithm Hash digest
SHA256 018af061635059570b5cee8ab01d9012ab63532c4d65931e059779b7fa7018b8
MD5 f48039615056de9a6f6bd192d016275d
BLAKE2b-256 778b3c85b06c961ce92314a770ed1ab36b5faf48a9871655a254c88643e48891

See more details on using hashes here.

Provenance

The following attestation bundles were made for led_ticker_rss-0.2.0.tar.gz:

Publisher: publish.yml on JamesAwesome/led-ticker-plugins

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file led_ticker_rss-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: led_ticker_rss-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for led_ticker_rss-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 534ec6971682b3bbbd4c1103808a84ab3092afc5f7deecfa12fe295bb731cbc8
MD5 7d960157bfcf4ee2f60292c6caf403a5
BLAKE2b-256 fafb01d5a604795e35355c23e7d68ff481f10f9cfdd1767164eed862e04d7abf

See more details on using hashes here.

Provenance

The following attestation bundles were made for led_ticker_rss-0.2.0-py3-none-any.whl:

Publisher: publish.yml on JamesAwesome/led-ticker-plugins

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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