Nigel Metheringham
Repositories Projects Packages
4
 Public activity Starred repositories

generate-rss (1.0.4)

Published 2025-03-08 15:48:21 +00:00 by nigel

Installation

pip install --index-url  generate-rss

About this package

Generate RSS feeds from media files in a directory

Generate Podcast RSS

generate_rss is a tool for generating an RSS 2.0 feed from media files within a directory. It can search for files recursively in subdirectories and restrict the search to specific file extensions.

Installation

Currently not on pypi - needs to be downloaded from its source repo.

Usage

generate_rss --help

usage: generate_rss [-h] [--version] [-v] [-r] [-L] [-e STRING] [-o FILE]
                    [-b URL]
                    DIRECTORY

Generates an RSS feed from files in a directory

positional arguments:
  DIRECTORY             Directory to look for media files in.

options:
  -h, --help            show this help message and exit
  --version, -V         show program's version number and exit
  -v, --verbose         Verbose debug output
  -r, --recursive       Look for media files recursively in subdirectories
  -L, --follow-symlinks
                        Follow symbolic links when doing a recursive scan
  -e, --extensions STRING
                        A comma separated list of extensions for audio files -
                        ie podcast episodes. [Default: mp3,mp4,m4a,avi,ogg]
  -o, --out FILE        Output RSS file [Default: index.xml within podcast
                        directory].
  -b, --baseurl URL     Base URL of the base directory where your media
                        directory is located. [Default: should be specified in
                        podcast.yaml file]

Works through each matching file in the directory, creating a podcast episode
entry based on the file metadata. A podcast channel definition is created based
on the details in `podcast.yaml` within the podcast directory. The
`podcast.yaml` file can contain the following keys:- - `baseurl` - the base URL
of the podcast (effectively the URL of the directory). - `link` - the link to
the podcast - basedir/index.xml - `title` - podcast title - `author` - podcast
author - `description` - podcast description - `subtitle` - podcast subtitle -
`summary` - podcast summary - `image` - url to an image

Podcast Channel Definition File

Each podcast directory should have a podcast.yaml file in the directory. The keys in this file correspond to the aspects of a channel definition:-

  • baseurl - the base URL of the podcast (effectively the URL of the directory).
  • link - the link to the podcast - basedir/index.xml
  • title - podcast title
  • author - podcast author
  • description - podcast description
  • subtitle - podcast subtitle
  • summary - podcast summary
  • image - url to an image

for example:-

---
baseurl: https://podcasts.example.com/Podcast/
#link: https://podcasts.example.com/Podcast/index.xml
title: My Podcast
author: Me, Myself and I
description: Some Podcast, hopefully of interest to a few people.
subtitle: Supposedly funny
summary: Maybe jokes
image: https://cdn.pixabay.com/photo/2023/03/17/08/50/podcast-7858186_960_720.png

Requirements

Requires Python: <4.0,>=3.13
Details
PyPI
2025-03-08 15:48:21 +00:00
4
4.9 MiB
Assets (2)
generate_rss-1.0.4-py3-none-any.whl 9.8 KiB
generate_rss-1.0.4.tar.gz 4.9 MiB
Versions (4) View all
1.0.4 2025-03-08
1.0.3 2025-01-26
1.0.1 2025-01-26
1.0.0 2025-01-26