Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kiosk

CI

A terminal RSS/Atom reader built with Textual. Stop by, read, move on - no tracking, no algorithm, no account.

Philosophy

A newsstand kiosk doesn't remember your face, doesn't rank headlines by what keeps you there longest, and doesn't build a profile of your interests. You walk up, read what's there, and walk away. Kiosk works the same way:

  • No algorithm - articles show up in the order your feeds return them. Nothing is reordered to maximize how long you stay.
  • No tracking - no account, no read-history sent anywhere, no analytics.
  • A curated set of sources, not an endless list - you choose what's in your feed list; nothing is auto-suggested or auto-added.

Features

  • Clean and responsive TUI interface
  • Parses RSS/Atom feeds with HTML-to-text conversion for readable articles
  • Add, manage, and remove your own feeds directly in the app
  • Built-in discover list of starter feeds (Hacker News, The Verge, TechCrunch, and more) - add any with one click
  • Live search-as-you-type across the current feed's articles
  • Feeds are cached after first load, so reopening one doesn't refetch it
  • Clear, specific error messages - a dead URL and a broken feed don't look the same
  • Simple, intuitive keyboard navigation (d dark mode, h home, / search, q quit)

Installation

From source

git clone https://github.com/whaiman/kiosk.git
cd kiosk
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
pip install -e .

Run:

kiosk

Check the version:

kiosk --version

Supported platforms

Every push is tested on Linux, macOS, and Windows across Python 3.10 and 3.12 - see the CI badge above for current status.

Usage

On first launch, Kiosk loads a small set of built-in example feeds so there's something to read immediately.

  • Add feed - add any RSS/Atom URL by name
  • Manage feeds - see everything you've added, remove what you don't want
  • Discover feeds - browse the starter list and add any of them in one click
  • Type in the search box while reading a feed to filter articles as you go

Roadmap

This project is actively developed. Planned next:

  • Marking articles as read/unread
  • Full-article fetching (beyond the RSS summary)
  • Vim-style keybindings (j/k, gg, G)
  • Offline reading mode with caching
  • Optional image previews (kitty protocol / chafa)
  • OPML import/export
  • Customizable themes and colors

Contributions are welcome - feel free to open issues or pull requests.

License

MIT License - see LICENSE.

About

A terminal RSS/Atom reader built with Textual. Stop by, read, move on - no tracking, no algorithm, no account.

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages