Skip to main content

Archive all episodes from your favorite podcasts

Project description

Podcast Archiver

Podcast Archiver Logo

version python downloads

Docker Build Tests pre-commit.ci

Maintainability codecov

ruff poetry pre-commit

A fast and simple command line client to archive all episodes from your favorite podcasts.

Podcast Archiver takes the feed URLs of your favorite podcasts and downloads all available episodes for you—even those "hidden" in paged feeds. You'll end up with a complete archive of your shows. The archiver also supports updating an existing archive, so that it lends itself to be set up as a cronjob.

⚠️ Podcast Archiver v1.0 completely changes the available command line options uses a new format for naming files (see changing the filename format below). Using it on an existing pre-v1.0 folder structure will re-download all episodes unless you use an equivalent template. ⚠️

Setup

Install via pipx:

pipx install podcast-archiver

Install via brew:

brew install janw/tap/podcast-archiver

Or use it via Docker:

docker run --tty --rm ghcr.io/janw/podcast-archiver --help

By default, the docker image downloads episodes to a volume mounted at /archive.

Usage

Run podcast-archiver --help for details on how to use it:

poetry run podcast-archiver --help

Example invocation

podcast-archiver -d ~/Music/Podcasts \
    -f http://logbuch-netzpolitik.de/feed/m4a \
    -f http://raumzeit-podcast.de/feed/m4a/ \
    -f https://feeds.lagedernation.org/feeds/ldn-mp3.xml

This way, you can easily add and remove feeds to the list and let the archiver fetch the newest episodes for example by adding it to your crontab.

Changing the filename format

Podcast Archiver has a --filename-template option that allows you to change the particular naming scheme of the archive. The default value for --filename-template. is shown in podcast-archiver --help, as well as all the available variables. The basic ones are:

  • Episode: episode.title, episode.subtitle, episode.author, episode.published_time, episode.original_filename
  • Podcast: show.title, show.subtitle, show.author, show.language

Note here that episode.published_time is a Python-native datetime, so its exact format can be adjusted further a la {episode.published_time:%Y-%m-%d %H%M%S} using strftime-placeholders. By default it uses %Y-%m-%d (e.g. 2024-12-31).

Examples

  • More precise published time

    {show.title}/{episode.published_time:%Y-%m-%d %H%M%S %Z} - {episode.title}.{ext}
    

    Results in …/That Show/2023-03-12 123456 UTC - Some Episode.mp3

  • Using the original filename (roughly equivalent to pre-1.0 --subdirs)

    {show.title}/{episode.original_filename}
    

    Results in …/That Show/ts001-episodefilename.mp3

  • Using the original filename (roughly equivalent to pre-1.0 --subdirs + --date-prefix)

    {show.title}/{episode.published_time} {episode.original_filename}
    

    Results in …/That Show/2023-03-12 ts001-episodefilename.mp3

Using a config file

Command line arguments can be replaced with entries in a YAML configuration file. An example config can be generated with

podcast-archiver --config-generate > config.yaml

After modifying the settings to your liking, podcast-archiver can be run with

podcast-archiver --config config.yaml

Alternatively (for example, if you're running podcast-archiver in Docker), you may point it to the config file using the PODCAST_ARCHIVER_CONFIG=path/to/config.yaml environment variable.

Using environment variables

Some settings of Podcast Archiver are available as environment variables, too. Check podcast-archiver --help for options with env var: … next to them.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

podcast_archiver-1.4.1.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

podcast_archiver-1.4.1-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

Details for the file podcast_archiver-1.4.1.tar.gz.

File metadata

  • Download URL: podcast_archiver-1.4.1.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for podcast_archiver-1.4.1.tar.gz
Algorithm Hash digest
SHA256 307eacf28d2db53c3c3fcc98143c5a0c111b4ea75a34030ee21bdcf76959b92c
MD5 f513abaccb04a1f6c4bd84220da4151a
BLAKE2b-256 c3a622300246f701380204410b090229a4edbe27dc265131985ff5577b2a7b5c

See more details on using hashes here.

Provenance

File details

Details for the file podcast_archiver-1.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for podcast_archiver-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a56c9a32957ffe9ab2eb5fe3167da3430c321d1c74930fd80e48fe9c58ac6575
MD5 d32488e26d3d29b3cd1e3ba5e491b510
BLAKE2b-256 391663997f925fb4614666dc92fafe1ca17d9ed7436956a5db70d0205a56e5c3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page