Skip to content

m0wer/yaml2rss

Repository files navigation

yaml2rss

Actions Status pre-commit

Installation

Run pip install ..

For podcast generation you will need to install sndifile and ffmpeg (e.g., apt-get install libsndfile-dev ffmpeg).

Usage

Generate podcast feed

  1. Copy and modify examples/podcast.yaml.
  2. From the root path of your podcast project (where the recordings/ directory is), run:
yaml2rss generate podcast podcast.yaml podcast.xml

Example build script

This scripts converts the audio files to the same format, normalizes the volume and creates a zip file with all the recordings:

#!/bin/sh

set -e

parallel "ffmpeg -i {1} {1.}.mp3 && rm {1}" ::: recordings/*.ogg || true
mp3gain -r -k -a -c recordings/*.mp3
yaml2rss generate podcast podcast.yaml podcast.xml
zip -r recordings.zip recordings/*.mp3

Development

Run make install to install all development dependencies.

Documentation

You can access the online version at https://m0wer.github.io/yaml2rss/.

Alternatively, after make install, to render the documentation run:

pip install -r requirements.txt
mkdocs serve

You can now access the docs at http://localhost:8000.