https://github.com/m0wer/yaml2rss

Generate a RSS podcast feed from YAML.
https://github.com/m0wer/yaml2rss

audio podcast rss rss-feed rss-generator xml yaml

Last synced: 8 days ago
JSON representation

Generate a RSS podcast feed from YAML.

• Host: GitHub
• URL: https://github.com/m0wer/yaml2rss
• Owner: m0wer
• License: gpl-3.0
• Created: 2022-01-23T17:03:35.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-27T07:39:59.000Z (over 2 years ago)
• Last Synced: 2024-11-12T02:36:31.516Z (about 2 months ago)
• Topics: audio, podcast, rss, rss-feed, rss-generator, xml, yaml
• Language: Python
• Homepage: https://m0wer.github.io/yaml2rss
• Size: 576 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yaml2rss

[![Actions Status](

https://github.com/m0wer/yaml2rss/workflows/main.yml/badge.svg

)](https://github.com/m0wer/yaml2rss/actions)

[![pre-commit](

https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white

)](https://github.com/pre-commit/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`.

1. From the root path of your podcast project (where the `recordings/`

  directory is), run:

  ```bash

  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:

```bash

#!/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 .

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

```bash

pip install -r requirements.txt

mkdocs serve

```

You can now access the docs at .