offshore-podcast 0.4.0

A local-first podcast feed generator and editor.

offshore

Homepage ･ Repository ･ PyPI package ･ Tickets

Local-first podcast feed generator and editor. Manage show metadata and episodes locally, generate a standards-compliant RSS 2.0 + iTunes feed, and serve or publish the output anywhere.

To contribute, please send patch to ~lamons/[e-mail].

Screenshots^†

Requirements

Python 3.11 or later.

Installation

pip install offshore-podcast

Or from source:

pip install -e .

Quick start

offshore serve          # opens the web UI at http://127.0.0.1:8765

Data layout

Every show lives in its own subdirectory inside the shows root.

~/offshore/              # default shows root (configurable)
  <slug>/
    <slug>.json          # show and episode metadata
    <slug>.lock.json     # feed stability lock (GUID / pub_date history)
    <slug>.report.json   # check results 
    podcast.xml          # generated feed (default location)
    rss.xsl              # generated stylesheet (default location)

<slug>.json is the primary data file. It stores everything that ends up in the feed: show title, description, language, categories, cover image URL, feed self-link, episodes with their audio URLs, shownotes, persons, and more.

<slug>.lock.json records each episode's GUID and pub_date when it is first saved. Any later change to these values through a normal save is rejected, protecting subscribers from duplicate entries. Use offshore republish to intentionally move an episode date.

<slug>.report.json holds the result of the latest check run, including per-episode audio and image verification results. It's auto-generated to be read by offshore and should not be manually edited.

Documentation

Development

pip install -e ".[dev]"
python -m pytest

Acknowledgement

^†: The example feed in the screenshots is from Preserve This Podcast.
The episode check result icons use Bootstrap Icons.