Skip to content

Monitors incoming feeds to the Podcast Index API for triage and management.

License

Notifications You must be signed in to change notification settings

Podcastindex-org/pimonitor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Podcast Index Monitor

This command line application monitors the Podcast Index API for new feeds and allows rudimentary analysis of them. This is a work in progress.

Key bindings

  • q to quit
  • r to refresh the feed list
  • s to search the feed list by text or feed id
  • p to play the latest enclosure for the selected feed
  • x to view the RSS xml for the selected feed
  • d to mark a feed as problematic
  • Esc to exit a dialog or stop
  • (on vim mode) ? to show help and vim key bindings

Features / Options

  • --config command-line flag to allow pimonitor to read configuration from a custom file path instead of the default pimonitor.yaml.
  • --vim command-line flag to enable vim mode. Press ? to show what it does.
  • Audio formats and extensions supported:
    • audio/mp4 | audio/x-m4a | audio/aacp => .m4a | .mp4
    • audio/aac => .aac
    • audio/mpeg => .mp3
    • audio/ogg => .ogg
    • audio/opus => .opus
    • audio/wav | audio/x-wav => .wav
    • audio/flac => .flac

Planned features

  • Add a feed
  • Rescan a feed
  • Adjust apple directory linkage
  • Mark a feed as dead
  • Mark a feed as spam
  • Plugin architecture for automation

LLM/AI guidelines

This is an LLM/AI friendly repository. When coding on this repository using LLM/AI agents please follow the guidelines in the AGENTS.md file.

Dependencies

Rust

You need rust in order to lauch/compile this tool.

  • In ArchLinux you can just install rust or rustup (recommended if you intend to do development) with : pacman -S rust

Podcast Index API Key

Optional functionality: In order to interact with the Index to report a problem (d key) you need to configure pimonitor.yaml with your PI key:

pi_api_key: ""
pi_api_secret: ""

Installation

You can just clone this repo and run the tool with:

git clone https://github.com/Podcastindex-org/pimonitor.git && cd "$(basename "$_" .git)"
cargo run

Usage examples

  • Using vim mode
cargo run -- --vim
  • Using custom configuration file
cargo run -- --config /etc/pimonitor/config.yaml
  • Using custom config in vim mode
cargo run -- --vim --config ./custom.yaml

Screenshot

imagen

About

Monitors incoming feeds to the Podcast Index API for triage and management.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •