dominic/rss-generator
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rss-generator/README.md
Dominic DiTaranto 492b513885 initial commit
2026-04-17 00:45:51 -04:00

2.7 KiB
Raw Blame History

RSS GENERATOR

This is an rss feed generator with a pseudo TUI interface. This was mainly created for people who are utilizing basic HTML to write a blog.

While, of course, experienced developers take this simplistic route, a majority of people who are just writing their blogs manually are new to web development. This application is intended to provide the newbies a way to easily generate an RSS feed. Think about the people on neocities or in the tildeverse.

Because this software is made for new web developer, I provide a very detailed explanation on how to "install" and "run" this "program" below. If you already know what to do, just clone the repo and run the code bruh.

Capabilities:

  1. Generate an RSS feed
  2. Add a post entry to an existing RSS feed
  3. List all post entries in TUI
  4. Edit a post entry
  5. Delete a post entry
  6. Only saves when you explicitly state, so bulk operation are possible.

Dependencies

  • python
  • git

NOTE there are no third party packages used, so you do not need a virtual environment and you do not need to pip install anything!

How To

  1. Using the terminal, clone this repository into the base directory of your website.

git clone https://git.domdit.com/dominic/rss-generator

If you do not have git installed, you should install it on your system. If you cannot install it, you can copy the contents of generator.py and config.py into a new folder called rss-generator inside the base directory of your website.

NOTE If you are cloning this repo inside an already existing git repo, consider adding this repo as a submodule instead git submodule add https://git.domdit.com/dominic/rss-generator rss-generator

  1. Inside the rss-generator directory, there is a config file. You must fill out this config file. there are detailed instructions to follow along inside the config file.

  2. Once the config file is filled out and saved, you can now run python3 generator.py

  3. If this is the first time running it, it will generate a new rss feed for you and ask you to fill out information for your first (most recent) blog post

  4. You will then be redirected to the action menu, if you just want to save, you can type the number 5 and hit enter.

  5. You can also do other operations like see the list of all of your blog posts, edit a blog post rss entry, or delete a blog post rss entry

  6. changes do not take place until you explicity his save. so if you mess up you can always quit without saving and start over.

  7. Make sure your rss feed looks correct, and is where you want it. If you did not change XML_BASE_PATH, it will be in the base directory of your website

  8. Now that you have an rss feed, make sure you link to it somewhere on your website so people can find it!