Skip to main content

AI-powered Plex playlist generator using mood-based queries

Project description

PlexMix Logo

PlexMix

License: MIT PyPI version Python 3.10+

AI-powered Plex playlist generator using mood-based queries

PlexMix syncs your Plex music library to a local SQLite database, generates semantic embeddings for tracks, and uses AI to create personalized playlists based on mood descriptions.

Features

  • โœจ Simple Setup - Only requires a Google API key to get started
  • ๐ŸŽต Smart Sync - Syncs Plex music library with incremental updates
  • ๐Ÿค– AI-Powered - Uses Google Gemini, OpenAI GPT, or Anthropic Claude
  • ๐Ÿท๏ธ AI Tagging - Automatically generates tags, environments, and instruments for tracks
  • ๐Ÿ” Semantic Search - FAISS vector similarity search for intelligent track matching
  • ๐ŸŽจ Mood-Based - Generate playlists from natural language descriptions
  • โšก Fast - Local database with optimized indexes and full-text search
  • ๐ŸŽฏ Flexible - Filter by genre, year, rating, artist, environment, and instrument

Quick Start

Option 1: Command Line Interface (Recommended)

# Install from PyPI
pip install plexmix

# Run setup wizard
plexmix config init

# Sync your Plex library (generates embeddings automatically)
plexmix sync full

# Generate AI tags for tracks (enhances search quality)
plexmix tags generate

# Create a playlist
plexmix create "upbeat morning energy"

# With filters
plexmix create "chill evening vibes" --genre jazz --year-min 2010 --limit 30

# Filter by environment and instrument
plexmix create "focus music" --environment study --instrument piano

# Use alternative AI provider
plexmix create "workout motivation" --provider openai

# If you encounter issues (e.g., "0 candidate tracks")
plexmix doctor

# Force regenerate all tags and embeddings
plexmix doctor --force

Option 2: Web User Interface (Alpha)

Note: The Web UI is currently in Alpha status. The CLI is the recommended way to interact with PlexMix for production use.

# Install with UI extras
pip install "plexmix[ui]"

# Or if using poetry
poetry install -E ui

# Launch the web UI
plexmix ui

# Optional: Specify host and port
plexmix ui --host 0.0.0.0 --port 8000

Then open your browser to http://localhost:3000

Screenshots

Dashboard - Light Mode Dashboard - Dark Mode

Dashboard with configuration status and library statistics

Playlist Generator

AI-powered playlist generator with mood-based queries

Library Manager

Browse and manage your music library with advanced filtering

Settings

Configure Plex, AI providers, and embeddings

Web UI Features

The web interface provides a modern, intuitive way to interact with PlexMix:

  • ๐Ÿ“Š Dashboard - Overview of library stats, configuration status, and quick actions
  • โš™๏ธ Settings - Configure Plex, AI providers, and embeddings with real-time validation
  • ๐Ÿ“š Library Manager - Browse, search, and sync your music library with live progress tracking
  • ๐ŸŽต Playlist Generator - Create mood-based playlists with advanced filters and instant preview
  • ๐Ÿท๏ธ AI Tagging - Batch generate tags for tracks with progress monitoring
  • ๐Ÿ“œ Playlist History - View, export, and manage all generated playlists

Key UI Features

  • ๐ŸŒ“ Dark/Light Mode - Toggle between themes with automatic logo switching
  • Real-time Progress - Live updates for sync, tagging, and generation operations
  • Form Validation - Instant feedback on configuration settings
  • Loading States - Skeleton screens and spinners for smooth UX
  • Error Handling - User-friendly error messages with recovery options
  • Responsive Design - Works on desktop and tablet devices

Installation

From PyPI (Recommended)

pip install plexmix

From Source

git clone https://github.com/izzoa/plexmix.git
cd plexmix
poetry install

Configuration

PlexMix uses Google Gemini by default for both AI playlist generation and embeddings, requiring only a single API key!

Required

  • Plex Server: URL and authentication token
  • Google API Key: For Gemini AI and embeddings (Get one here)

Optional Alternative Providers

  • OpenAI API Key: For GPT models and text-embedding-3-small
  • Anthropic API Key: For Claude models (AI only, no embeddings)
  • Cohere API Key: For Command R7B and Embed v4 models
  • Local Embeddings: sentence-transformers (free, offline, no API key needed)

Getting a Plex Token

  1. Open Plex Web App
  2. Play any media item
  3. Click the three dots (...) โ†’ Get Info
  4. View XML
  5. Copy the X-Plex-Token from the URL

Usage

Configuration Commands

# Interactive setup wizard
plexmix config init

# Show current configuration
plexmix config show

Sync Commands

# Full sync with embedding generation
plexmix sync full

# Sync without embeddings
plexmix sync full --no-embeddings

Database Health Check

# Diagnose and fix database issues
plexmix doctor

# Force regenerate all tags and embeddings
plexmix doctor --force

What does doctor do?

  • Detects orphaned embeddings (embeddings that reference deleted tracks)
  • Shows database health status (track count, embeddings, orphans)
  • Interactively removes orphaned data
  • Regenerates missing embeddings
  • Rebuilds vector index

What does --force do?

  • Deletes ALL tags, environments, instruments, and embeddings
  • Regenerates tags for all tracks using Gemini AI
  • Regenerates embeddings with the new tags
  • Rebuilds the complete vector index from scratch

When to use:

  • After "No tracks found matching criteria" errors
  • When playlist generation finds 0 candidates
  • After database corruption or manual track deletion
  • Periodic maintenance to keep database healthy
  • Use --force when you want to start completely fresh with AI-generated data

Tag Generation

# Generate AI tags for all untagged tracks
plexmix tags generate

# Use alternative AI provider
plexmix tags generate --provider openai

# Skip embedding regeneration (faster, but tags won't be in search)
plexmix tags generate --no-regenerate-embeddings

Embedding Generation

# Generate embeddings for tracks without them
plexmix embeddings generate

# Regenerate all embeddings from scratch
plexmix embeddings generate --regenerate

What are tags? AI-generated metadata (per track) that enhances semantic search:

  • Tags (3-5): Mood descriptors like energetic, melancholic, upbeat, chill, intense
  • Environments (1-3): Best-fit contexts like work, study, focus, relax, party, workout, sleep, driving, social
  • Instruments (1-3): Most prominent instruments like piano, guitar, saxophone, drums, bass, synth, vocals, strings

All metadata is automatically included in embeddings for more accurate mood-based playlist generation.

Playlist Generation

# Basic playlist (prompts for track count)
plexmix create "happy upbeat summer vibes"

# Specify track count
plexmix create "rainy day melancholy" --limit 25

# Filter by genre
plexmix create "energetic workout" --genre rock --limit 40

# Filter by year range
plexmix create "90s nostalgia" --year-min 1990 --year-max 1999

# Filter by environment (work, study, focus, relax, party, workout, sleep, driving, social)
plexmix create "workout energy" --environment workout

# Filter by instrument (piano, guitar, saxophone, drums, etc.)
plexmix create "piano jazz" --instrument piano

# Use specific AI provider
plexmix create "chill study session" --provider claude

# Custom playlist name
plexmix create "morning coffee" --name "Perfect Morning Mix"

# Adjust candidate pool multiplier (default: 25x playlist length)
plexmix create "diverse mix" --limit 20 --pool-multiplier 50

# Don't create in Plex (save locally only)
plexmix create "test playlist" --no-create-in-plex

Architecture

PlexMix uses a multi-stage pipeline for intelligent playlist generation:

  1. AI Tagging (One-time setup) โ†’ Tracks receive:

    • 3-5 descriptive tags (mood, energy, tempo, emotion)
    • 1-3 environments (work, study, focus, relax, party, workout, sleep, driving, social)
    • 1-3 instruments (piano, guitar, saxophone, drums, bass, synth, vocals, strings, etc.)
  2. Playlist Generation Pipeline:

    • SQL Filters โ†’ Apply optional filters (genre, year, rating, artist, environment, instrument)
    • Candidate Pool โ†’ Search using FAISS vector similarity (default: 25x playlist length)
    • Diversity Selection โ†’ Apply algorithmic diversity rules:
      • Max 3 tracks per artist
      • Max 2 tracks per album
      • No duplicate track/artist combinations
    • Final Playlist โ†’ Return curated, diverse track list

Technology Stack

  • Language: Python 3.10+
  • CLI: Typer with Rich console output
  • Database: SQLite with FTS5 full-text search
  • Vector Search: FAISS (CPU) with cosine similarity
  • AI Providers: Google Gemini (default), OpenAI GPT, Anthropic Claude, Cohere
  • Embeddings: Google Gemini (3072d), OpenAI (1536d), Local (384-768d)
  • Plex Integration: PlexAPI

Project Structure

plexmix/
โ”œโ”€โ”€ src/plexmix/
โ”‚   โ”œโ”€โ”€ ai/               # AI provider implementations
โ”‚   โ”‚   โ”œโ”€โ”€ base.py       # Abstract base class
โ”‚   โ”‚   โ”œโ”€โ”€ gemini_provider.py
โ”‚   โ”‚   โ”œโ”€โ”€ openai_provider.py
โ”‚   โ”‚   โ”œโ”€โ”€ claude_provider.py
โ”‚   โ”‚   โ””โ”€โ”€ tag_generator.py  # AI-based tag generation
โ”‚   โ”œโ”€โ”€ cli/              # Command-line interface
โ”‚   โ”‚   โ””โ”€โ”€ main.py       # Typer CLI app
โ”‚   โ”œโ”€โ”€ config/           # Configuration management
โ”‚   โ”‚   โ”œโ”€โ”€ settings.py   # Pydantic settings
โ”‚   โ”‚   โ””โ”€โ”€ credentials.py # Keyring integration
โ”‚   โ”œโ”€โ”€ database/         # Database layer
โ”‚   โ”‚   โ”œโ”€โ”€ models.py     # Pydantic models
โ”‚   โ”‚   โ”œโ”€โ”€ sqlite_manager.py # SQLite CRUD
โ”‚   โ”‚   โ””โ”€โ”€ vector_index.py   # FAISS index
โ”‚   โ”œโ”€โ”€ plex/             # Plex integration
โ”‚   โ”‚   โ”œโ”€โ”€ client.py     # PlexAPI wrapper
โ”‚   โ”‚   โ””โ”€โ”€ sync.py       # Sync engine
โ”‚   โ”œโ”€โ”€ playlist/         # Playlist generation
โ”‚   โ”‚   โ””โ”€โ”€ generator.py  # Core generation logic
โ”‚   โ”œโ”€โ”€ ui/               # Web UI (Reflex)
โ”‚   โ”‚   โ”œโ”€โ”€ app.py        # Main Reflex app
โ”‚   โ”‚   โ”œโ”€โ”€ pages/        # UI pages
โ”‚   โ”‚   โ”œโ”€โ”€ states/       # State management
โ”‚   โ”‚   โ”œโ”€โ”€ components/   # Reusable components
โ”‚   โ”‚   โ””โ”€โ”€ utils/        # UI utilities
โ”‚   โ””โ”€โ”€ utils/            # Utilities
โ”‚       โ”œโ”€โ”€ embeddings.py # Embedding providers
โ”‚       โ””โ”€โ”€ logging.py    # Logging setup
โ””โ”€โ”€ tests/                # Test suite
    โ””โ”€โ”€ ui/               # UI tests

Database Schema

PlexMix stores all music metadata locally:

  • artists: Artist information
  • albums: Album details with artist relationships
  • tracks: Track metadata with full-text search, AI-generated tags (3-5), environments (1-3), and instruments (1-3)
  • embeddings: Vector embeddings for semantic search (includes all AI-generated metadata)
  • playlists: Generated playlist metadata
  • sync_history: Synchronization audit log

AI Provider Comparison

Provider Model Context Window Default Temp Speed Quality Cost Best For
Google Gemini โญ gemini-2.5-flash 1M tokens 0.7 โšกโšกโšก Fast โญโญโญโญ Excellent ๐Ÿ’ฐ Low General use, RAG, large contexts
OpenAI gpt-5-mini 400K tokens 0.7 โšกโšก Moderate โญโญโญโญโญ Outstanding ๐Ÿ’ฐ๐Ÿ’ฐ Medium High-quality responses, reasoning
OpenAI gpt-5-nano 400K tokens 0.7 โšกโšกโšก Fast โญโญโญโญ Excellent ๐Ÿ’ฐ Low Speed-optimized, efficient
Cohere command-r7b-12-2024 128K tokens 0.3 โšกโšกโšก Fast โญโญโญโญ Excellent ๐Ÿ’ฐ Low RAG, tool use, agents
Cohere command-r-plus-08-2024 128K tokens 0.3 โšกโšก Moderate โญโญโญโญโญ Outstanding ๐Ÿ’ฐ๐Ÿ’ฐ Medium Multilingual, complex tasks
Cohere command-r-08-2024 128K tokens 0.3 โšกโšกโšก Fast โญโญโญโญ Excellent ๐Ÿ’ฐ Low Balanced performance
Anthropic claude-sonnet-4-5 200K tokens 0.7 โšกโšก Moderate โญโญโญโญโญ Outstanding ๐Ÿ’ฐ๐Ÿ’ฐ๐Ÿ’ฐ High Advanced reasoning, analysis
Anthropic claude-3-5-haiku-20241022 200K tokens 0.7 โšกโšกโšก Fast โญโญโญโญ Excellent ๐Ÿ’ฐ Low Fast responses, efficiency

Legend:

  • โญ Default/recommended option
  • Speed: โšก Slow, โšกโšก Moderate, โšกโšกโšก Fast
  • Quality: โญ Basic โ†’ โญโญโญโญโญ Outstanding
  • Cost: ๐Ÿ’ฐ Low, ๐Ÿ’ฐ๐Ÿ’ฐ Medium, ๐Ÿ’ฐ๐Ÿ’ฐ๐Ÿ’ฐ High

Embedding Provider Comparison

Provider Model Dimensions Quality Speed Cost API Key Best For
Google Gemini โญ gemini-embedding-001 3072 โญโญโญโญโญ Outstanding โšกโšก Moderate ๐Ÿ’ฐ Low Required High-dimensional, accurate semantic search
OpenAI text-embedding-3-small 1536 โญโญโญโญ Excellent โšกโšกโšก Fast ๐Ÿ’ฐ๐Ÿ’ฐ Medium Required Balanced performance, OpenAI ecosystem
Cohere embed-v4 256/512/1024/1536 โญโญโญโญ Excellent โšกโšกโšก Fast ๐Ÿ’ฐ Low Required Flexible dimensions (Matryoshka), multimodal
Local all-MiniLM-L6-v2 384 โญโญโญ Good โšกโšกโšก Fast ๐Ÿ’ฐ Free None Offline use, privacy, no API costs

Key Features:

  • Gemini: Highest dimensions (3072d) for maximum semantic precision
  • OpenAI: Industry standard, excellent ecosystem integration
  • Cohere: Configurable dimensions (256/512/1024/1536), supports images with v4
  • Local: Completely free, offline, private, no internet required

Dimension Trade-offs:

  • Higher dimensions = Better semantic understanding but larger storage
  • Lower dimensions = Faster search but slightly less accurate
  • Cohere's Matryoshka embeddings allow dynamic dimension selection

Development

Setup Development Environment

# Clone repository
git clone https://github.com/izzoa/plexmix.git
cd plexmix

# Install with development dependencies
poetry install

# Run tests
poetry run pytest

# Format code
poetry run black src/

# Lint
poetry run ruff src/

# Type check
poetry run mypy src/

Running Tests

poetry run pytest
poetry run pytest --cov=plexmix --cov-report=html

Troubleshooting

"No music libraries found"

  • Ensure your Plex server has a music library
  • Verify your Plex token is correct
  • Check server URL is accessible

"Failed to generate embeddings"

  • Verify API keys are configured correctly
  • Check internet connection
  • Try local embeddings: --embedding-provider local

"No tracks found matching criteria"

  • First, try: plexmix doctor to check for database issues
  • Ensure library is synced: plexmix sync full
  • Check filters aren't too restrictive
  • Verify embeddings were generated

"0 candidate tracks" or "No orphaned embeddings"

  • This usually means embeddings reference old track IDs
  • Solution: Run plexmix doctor to detect and fix orphaned embeddings
  • The doctor will clean up orphaned data and regenerate embeddings

Performance Tips

  • Use local embeddings for faster offline operation
  • Run sync during off-peak hours for large libraries
  • Adjust candidate pool multiplier based on library size (default: 25x playlist length)
    • Smaller libraries: Use lower multiplier (10-15x) for faster generation
    • Larger libraries: Use higher multiplier (30-50x) for better diversity
  • Use filters to narrow search space

FAQ

How does PlexMix work?

PlexMix syncs your Plex music library to a local SQLite database, generates AI-powered tags (mood, instruments, environments) for each track, creates semantic embeddings, and uses vector similarity search combined with LLM intelligence to generate playlists from natural language mood descriptions.

Do I need an API key?

Yes, but only one! Google Gemini is the default provider for both AI and embeddings. You can get a free API key at Google AI Studio. Alternative providers (OpenAI, Anthropic, local embeddings) are optional.

How much does it cost to run?

Google Gemini (default):

  • Embedding generation: ~$0.10-0.30 for 10,000 tracks (one-time)
  • Tag generation: ~$0.20-0.50 for 10,000 tracks (one-time)
  • Playlist creation: ~$0.01 per playlist (ongoing)

Alternatives:

  • Local embeddings are completely free (no API key needed)
  • OpenAI and Anthropic have similar costs

How long does initial sync take?

  • Metadata sync: 5-15 minutes for 10,000 tracks
  • Tag generation: 30-60 minutes for 10,000 tracks
  • Embedding generation: 15-30 minutes for 10,000 tracks

Total: ~1-2 hours for a large library. You can interrupt and resume at any time.

Can I use this without internet?

Partially. After initial sync and tag/embedding generation, you can:

  • โœ… Browse your database offline
  • โœ… Use local embeddings (no API needed)
  • โŒ Generate new playlists (requires AI API)
  • โŒ Generate tags for new tracks (requires AI API)

What's the difference between tags, environments, and instruments?

  • Tags (3-5): Mood and vibe descriptors like "energetic", "melancholic", "upbeat", "chill"
  • Environments (1-3): Best contexts for listening like "work", "study", "workout", "party"
  • Instruments (1-3): Most prominent instruments like "piano", "guitar", "saxophone", "drums"

All three are automatically generated by AI and improve playlist quality.

Why am I getting "0 candidate tracks"?

This usually means:

  1. No embeddings generated: Run plexmix embeddings generate
  2. Database out of sync: Run plexmix doctor to fix
  3. Filters too restrictive: Remove some filters and try again
  4. Empty library: Ensure plexmix sync full completed successfully

Can I use multiple Plex libraries?

Not yet. Currently PlexMix supports one music library at a time. Multi-library support is on the roadmap.

Does this modify my Plex server?

Only when creating playlists. PlexMix:

  • โœ… Reads metadata from Plex (read-only)
  • โœ… Creates playlists in Plex (if enabled with --create-in-plex)
  • โŒ Does NOT modify tracks, albums, or artists
  • โŒ Does NOT delete anything from Plex

What happens if I delete tracks from Plex?

Run plexmix sync full to update your local database. The sync will:

  • Remove deleted tracks from the database
  • Clean up orphaned embeddings
  • Update the vector index

Or use plexmix doctor to clean up orphaned data.

Can I backup my database?

Yes! Your database is stored at ~/.plexmix/plexmix.db. Simply copy this file and the ~/.plexmix/embeddings.index file to backup all your data, tags, and embeddings.

How do I update PlexMix?

pip install --upgrade plexmix

After updating, run plexmix sync full --no-embeddings to apply any database migrations.

Can I contribute?

Absolutely! See CONTRIBUTING.md for guidelines. We welcome bug reports, feature requests, and pull requests.

Roadmap

  • Docker support
  • Multi-library support
  • Playlist templates
  • Smart shuffle and ordering
  • Export/import playlists (M3U, JSON)
  • Audio feature analysis integration

Contributing

Contributions welcome! Please read CONTRIBUTING.md for guidelines.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests
  5. Submit a pull request

License

MIT License - see LICENSE for details

Acknowledgments

  • Built with Typer and Rich
  • Plex integration via python-plexapi
  • Vector search powered by FAISS
  • AI providers: Google, OpenAI, Anthropic, Cohere

Made with โค๏ธ for music lovers

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

plexmix-0.2.3.tar.gz (70.2 kB view details)

Uploaded Source

Built Distribution

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

plexmix-0.2.3-py3-none-any.whl (85.3 kB view details)

Uploaded Python 3

File details

Details for the file plexmix-0.2.3.tar.gz.

File metadata

  • Download URL: plexmix-0.2.3.tar.gz
  • Upload date:
  • Size: 70.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for plexmix-0.2.3.tar.gz
Algorithm Hash digest
SHA256 fec48670b9d021a40a9228cccba117d3d508363c6c3521b236b39abc9a41368f
MD5 907a70a938d7d68d3585b58123be0fab
BLAKE2b-256 ba36ef760ec213b1abde4cf78fd1c69b994dbc18f7b267c5f6fe7cc9c3aa279c

See more details on using hashes here.

Provenance

The following attestation bundles were made for plexmix-0.2.3.tar.gz:

Publisher: publish.yml on izzoa/plexmix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plexmix-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: plexmix-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 85.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for plexmix-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d1e525f763b5ab309e08b73e54cf7d7e62c31d9cfd9e436b32541dc2f59a6c2d
MD5 f5fd799b56fa400c7390ccc0dbfa3280
BLAKE2b-256 5a68f6112aa66fd912dec869a6d341d52d0920068f3bf5796ad692024cea340e

See more details on using hashes here.

Provenance

The following attestation bundles were made for plexmix-0.2.3-py3-none-any.whl:

Publisher: publish.yml on izzoa/plexmix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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