Skip to main content

Extract structured performance data from music program booklets using an LLM

Project description

podiumscan

podiumscan

Extract structured performance data from music program booklets using an LLM.

Reads competition schedules, concert programs, recital booklets, and event posters (PDF, DOC, DOCX, ODT, PNG, JPG, WEBP), finds performances by configured performers, and outputs structured JSON.

Setup

pip install podiumscan

Or for development:

git clone <repo-url>
cd podiumscan
make install-dev

On first run, the tool copies the example config to ~/.config/podiumscan/config.yaml automatically.

Edit ~/.config/podiumscan/config.yaml:

  • Set model to a vision-capable LLM (default: anthropic/claude-opus-4-6)
  • Set api_key to your provider's API key
  • Add your performers under performers

Usage

podiumscan document.pdf
podiumscan concert-poster.jpg
podiumscan -c "Look at page 3" program.pdf
podiumscan -v document.docx

Options

Flag Description
-c, --comment Additional guidance sent to the LLM (e.g. "Look at page 3")
-v, --verbose Show LLM explanation text on stderr

Exit codes

Code Meaning
0 Matches found, JSON written to stdout
1 No matches found
2 Error (details on stderr)

Output

JSON array to stdout. Example:

[
  {
    "event_name": "Spring Chamber Music Festival",
    "performance_date": "2025-11-15",
    "performer": "Emily Parker",
    "instrument": "violin",
    "pieces": [
      { "composer": "J. S. Bach", "title": "Partita No. 2 in D minor, BWV 1004 / Sarabande" },
      { "composer": "Dvorak", "title": "Slavonic Dance No. 2 in E minor" }
    ],
    "teacher": "Sarah Mitchell",
    "accompanist": "James Crawford",
    "co_performers": [
      { "name": "Tom Wilson", "instrument": "piano" }
    ]
  }
]

Config format

See config.example.yaml for the full format. Key sections:

  • model / api_key: LLM provider configuration
  • performers: list of people to search for, with instruments (including aliases), teachers, and accompanists with date ranges

How it works

  1. Detects file type and prepares the document
  2. Tries sending it to the LLM in progressively degraded formats: raw document, then PDF, then page images
  3. At each level, if the LLM returns invalid output, retries once with guidance
  4. Fills in missing teacher/accompanist data from config based on performance date
  5. Outputs JSON to stdout

Model updater

podiumscan-update-models

Queries an LLM for currently available PDF/vision-capable models, cross-references with LiteLLM's registry, and updates the commented model list in your config file.

Supported file types

PDF, DOC, DOCX, ODT, PNG, JPG, JPEG, WEBP

DOC/DOCX/ODT conversion requires libreoffice installed on the system.

Dependencies

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

podiumscan-0.1.2.tar.gz (21.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

podiumscan-0.1.2-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file podiumscan-0.1.2.tar.gz.

File metadata

  • Download URL: podiumscan-0.1.2.tar.gz
  • Upload date:
  • Size: 21.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for podiumscan-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6fb0ad023239839e3a46e5d7b3509787fa243b789d835a17d92d7a2dcf52c8bd
MD5 f63488b29a58f795607157827cf27b05
BLAKE2b-256 13cc5e60d4564c0655c7e87c78122b9a4767bd15f1a391c857d7e13589b608ce

See more details on using hashes here.

File details

Details for the file podiumscan-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: podiumscan-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 17.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for podiumscan-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b1bfca89ecb6799e946c364da649fe15967656d2ab04bb18b014f8414f8d76fc
MD5 76f39bb822b728ffc4a2d9cbf58bee2b
BLAKE2b-256 4cb200b65768fa60fa12471171c50c46015cb2319208c19669a8aed1853532ba

See more details on using hashes here.

Supported by

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