Skip to main content

Extract structured performance data from music program booklets using an LLM

Project description

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.0.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.0-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: podiumscan-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 c2223858f997faa3f6d6a0695727590fccdcab2b01cb2b1fcf7299f8afa15d2f
MD5 e99b6ee4f4323caba7b6b1ead1114d0a
BLAKE2b-256 ce189c3d089541ffada88ac520381cac2eebad59c90e9ac3ba3ceb27874e53f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: podiumscan-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1047511f2aad487f2a365072ba4838da6046810dad8ad35d7b072477e5ecbbd7
MD5 75ec711ffbc2bb574efa067489abdbe0
BLAKE2b-256 d395418f4e84669e0c8341654b367efb083f0308bf1652d53a1acd67c3dd84ae

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