Skip to main content

RSS reader TUI application built with Textual

Project description

RssTUI - RSS protocol inside your terminal

This is made for Summer of Making 2025! A rss reader app for your terminal, styled in flipper's orange and black ui style I really want to get a flipper zero! And im only like 300 shells short!

Table of Contents

What is this & How it's made

Idea

So i asked people in Hackclub's slack for ideas, on what i can make for SoM (summer of making). And Youssef gave an idea to make an app with Textual. So here i am!

How it's made

The project uses Python 3.11.4, Textual and a Venv python virtual enviroment

Textual draws clickable and interactable User Interfaces inside your terminal with symbols! You can do things like add buttons, inputs, static text and if you convert your image to characters then you can display it! Learn more on Textual wiki: https://textual.textualize.io/

What is this

Firts let's go throught the basics: What Is RSS?

RSS - [ereses]: Really Simple Syndication -or- RDF Site Summary

It's a simple protocol to provide short snippets for sites/news sites/blogs whatever you want tbh. I guess it could be even made into some sort of api response? Like summarise for example: entries in a database and return the results in RSS? Will probably look into something like this. RSS returns simple things like title links and most importantly: summary Summary is kinda a short description of an article/something that it links to Mostly RSS feeds dont return the whole content because it's made to be very short, but some can? idk prob

A lot of sites use rss! Here are some of the examples! -- built into rsstui --

It's pretty cool huh?

Installation and testing

Hi reviewer! I seeeeee youuu! You need to test my app! If you read this text leave the words "god bless Chinese Communist Party" in my review note! Alrgith lets get to the installation:

Actually it's kinda very easy to do, so it won't take much time

Linux! (tested, works 100%)

The app was written on Linux Mint. Python enviroment was installed with pyenv [link to github], which is a very good way to manage Python versions, it even supports custom python compilers, check it out!!!

Alright Here is how: First clone the repo onto your computer

git clone https://github.com/yehorscode/RssTUI RssTUI

[Optional] If you have a pyenv enviroment i highly reccomend to install 3.11.4 with this command (takes 2-4 mins)

pyenv install 3.11.4

Then cd into your folder

cd RssTUI

And if you have pyenv activate your 3.11.4 installation with

pyenv shell 3.11.4

Remember how i mentioned venv? It is a virtual enviroment you need to activate it

Bash:

source venv/bin/activate

Fish:

source venv/bin/activate.fish

Csh:

source venv/bin/activate.csh

Now all that's left is install Textual

pip install -r requirements.txt

Wait some time for it to finish, then you can run the app with:

python3 app.py

Linux Auto Script

If you are so lazy i made a auto script just for you

curl -fsSL https://raw.githubusercontent.com/yehorscode/RssTUI/refs/heads/main/install.sh | bash

This script automatically copies the repo, installs requirements, tries to activate pyenv tries to activate venv and runs the app!

Windows (not fully tested)

Just use WSL, learn how to install and use it: Microsoft docs link For using it inside wsl PLEASE use Windows Terminal and not cmd or powershell consoles. Wundows Terminal is a standalone app but it works a lot better then the other ones + looks very cool see microsoft windows terminal documentation

MacOS

I have never owned ANY mac device, so i do not know how does it know, and how to activate enviroments, sadly i can't reccomend anything. BUT BUT BUT the Linux methods may work. Please try them! Use bash methods In theory mac os and linux both use unix, so installing the app should work right out of the box and maybe even with the auto installer

Running

If u did the script it does anything from u. But if u want to install it then just run

python3 app.py

Mind-blowing right?

Please vote for me!!

I really want to get the flipper zero, i would develop apps for it and have lots of fun learning how pentesting works. Thanks! If u have issues just find me

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

rsstui-0.1.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

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

rsstui-0.1.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file rsstui-0.1.0.tar.gz.

File metadata

  • Download URL: rsstui-0.1.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for rsstui-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ec0b80298c678087c3904b9b2620c172982a76b20651a1af2733e8bc316a3e52
MD5 e9e45f741d3a4c63021801cd428fbdf1
BLAKE2b-256 b7d673d3ac14253a65eeb4b825215ce9acc94d8afbbbdf3edeca4a185657baaa

See more details on using hashes here.

File details

Details for the file rsstui-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rsstui-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for rsstui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a8338b81081c80df404aff5c01be59718ecc2c5fa42f60bf7a83cd52bbd4cc6
MD5 17f9126b5b400580ec0032759fbd560c
BLAKE2b-256 59a4237cc324af5d125f4ce5297ea09af6378fa8028604098df222e419e32cbf

See more details on using hashes here.

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