Skip to main content

Search and download high-quality audio from multiple sources

Project description

flacfetch

PyPI version Python Version Tests codecov License: MIT

flacfetch is a Python tool designed to search for and download high-quality audio files from various sources. It is optimized for finding specific tracks (songs) across both private music trackers and public sources, with intelligent prioritization of "Official" and "Original" releases.

Features

  • Precise Track Search:
    • Private Music Trackers: RED and OPS (API integration). Uses advanced file list filtering to find specific songs within album torrents, downloading only the required track.
    • Streaming Services: Spotify (via librespot, requires Premium account) - CD Quality FLAC (44.1kHz/16-bit).
    • Public Sources: YouTube (via yt-dlp).
  • Smart Prioritization:
    • Official Sources: Automatically prioritizes "Topic" channels and "Official Audio" on YouTube. Spotify results are always from official sources.
    • Quality Heuristics:
      • Trackers (RED/OPS): Prioritizes Lossless (FLAC) and healthy torrents (Seeders). Matches filename exactly to your query.
      • Spotify: CD-quality FLAC (44.1kHz/16-bit) via librespot capture. Prioritizes by popularity.
      • YouTube: Prioritizes newer uploads (Opus codec) over legacy uploads (AAC). Color-codes upload years to help you spot modern, high-quality streams (Green: 2020+, Yellow: 2015-2019, Red: <2015).
  • Flexible Interaction:
    • Interactive Mode: Present search results to the user for manual selection with rich, color-coded metadata (Seeders, Views, Duration).
    • Automatic Mode: Automatically select the highest ranked release.
  • Smart Downloading:
    • Selective BitTorrent: Uses Transmission daemon to download only the specific file matching your search query from larger album torrents (saving bandwidth).
    • Direct Downloads: Handles HTTP/Stream downloads for public sources.

Requirements

  • Python 3.10+
  • requests
  • yt-dlp
  • transmission-rpc
  • Transmission (daemon) - Required for BitTorrent downloads (Optional if only using YouTube)

Installing Transmission

Transmission is a lightweight, cross-platform BitTorrent client with RPC support.

  • Ubuntu/Debian: sudo apt install transmission-daemon
  • macOS: brew install transmission-cli
  • Windows: Download from transmissionbt.com

flacfetch will automatically start the transmission daemon if it's not running.

Installation

From PyPI (Recommended)

pip install flacfetch

From Source

git clone https://github.com/nomadkaraoke/flacfetch.git
cd flacfetch
pip install .

Development Installation

git clone https://github.com/nomadkaraoke/flacfetch.git
cd flacfetch
pip install -e ".[dev]"

Usage

CLI Usage

Standard Search (Artist - Title)

flacfetch "Seether" "Tonight"

Explicit Arguments (Recommended for precision)

flacfetch --artist "Seether" --title "Tonight"

Auto-download Highest Quality

flacfetch --auto --artist "Seether" --title "Tonight"

Output Options

# Specify output directory
flacfetch --artist "Seether" --title "Tonight" -o ~/Music

# Auto-rename to "ARTIST - TITLE.ext"
flacfetch --artist "Seether" --title "Tonight" --rename

# Specify exact filename
flacfetch --artist "Seether" --title "Tonight" --filename "my_song"

# Combine options
flacfetch --artist "Seether" --title "Tonight" -o ~/Music --rename

Verbose Logging

flacfetch -v "Seether" "Tonight"

Configuration

To use private music trackers, you must provide both an API Key and API URL:

# RED
export RED_API_KEY="your_api_key_here"
export RED_API_URL="your_tracker_url_here"
# OR
flacfetch "..." --red-key "your_key" --red-url "your_url"

# OPS
export OPS_API_KEY="your_api_key_here"
export OPS_API_URL="your_tracker_url_here"
# OR
flacfetch "..." --ops-key "your_key" --ops-url "your_url"

Spotify Configuration (Optional - requires Premium account)

Spotify provides CD-quality audio (44.1kHz/16-bit) captured via librespot and converted to FLAC. This uses the official Spotify Web API for authentication (OAuth) and librespot for audio capture.

Prerequisites:

  • Spotify Premium account
  • librespot binary: brew install librespot or cargo install librespot
  • ffmpeg for audio conversion

Setup:

# 1. Install Spotify extra dependencies
pip install flacfetch[spotify]

# 2. Create a Spotify Developer App
# Go to: https://developer.spotify.com/dashboard
# Click "Create App"
# Set redirect URI to: http://127.0.0.1:8888/callback
# Note your Client ID and Client Secret

# 3. Set environment variables
export SPOTIPY_CLIENT_ID='your-client-id'
export SPOTIPY_CLIENT_SECRET='your-client-secret'
export SPOTIPY_REDIRECT_URI='http://127.0.0.1:8888/callback'

# 4. First run will open browser for OAuth login (token cached automatically)
flacfetch "Artist" "Title"

# Disable Spotify if needed
flacfetch "Artist" "Title" --no-spotify

How it works:

  1. Uses Spotify Web API (via spotipy) for search and playback control
  2. Starts librespot as a Spotify Connect device with OAuth token
  3. Triggers playback via Web API, captures raw PCM via pipe backend
  4. Converts PCM to FLAC using ffmpeg

Note: The redirect URI must use 127.0.0.1 (not localhost) as per Spotify's updated security requirements.

Provider Priority

When multiple providers are configured, flacfetch searches them in priority order. By default: RED > OPS > Spotify > YouTube

This means RED is searched first, and only if it returns no results will OPS be searched, then Spotify, then YouTube. This prioritizes lossless sources first, then high-quality streaming.

# Use default priority (RED > OPS > Spotify > YouTube)
export RED_API_KEY="..."
export RED_API_URL="..."
export OPS_API_KEY="..."
export OPS_API_URL="..."
flacfetch "Artist" "Title" --auto

# Custom priority (e.g., prefer Spotify over trackers)
flacfetch "Artist" "Title" --provider-priority "Spotify,RED,OPS,YouTube"

# Or via environment variable
export FLACFETCH_PROVIDER_PRIORITY="OPS,RED,Spotify,YouTube"
flacfetch "Artist" "Title" --auto

# Disable fallback (only search highest priority provider)
flacfetch "Artist" "Title" --auto --no-fallback

Library Usage

Quick Example:

from flacfetch.core.manager import FetchManager
from flacfetch.core.models import TrackQuery
from flacfetch.providers.red import REDProvider
from flacfetch.providers.ops import OPSProvider
from flacfetch.providers.spotify import SpotifyProvider  # Optional
from flacfetch.downloaders.spotify import SpotifyDownloader  # Optional

manager = FetchManager()
manager.add_provider(REDProvider(api_key="...", base_url="..."))
manager.add_provider(OPSProvider(api_key="...", base_url="..."))

# Spotify (requires SPOTIPY_CLIENT_ID, SPOTIPY_CLIENT_SECRET, SPOTIPY_REDIRECT_URI env vars)
spotify_provider = SpotifyProvider()
manager.add_provider(spotify_provider)
manager.register_downloader("Spotify", SpotifyDownloader(provider=spotify_provider))

# Search for a specific track
results = manager.search(TrackQuery(artist="Seether", title="Tonight"))
best = manager.select_best(results)

if best:
    # Download returns the path to the downloaded file
    file_path = manager.download(
        best, 
        output_path="./downloads",
        output_filename="Seether - Tonight"  # Optional: custom filename
    )
    print(f"Downloaded to: {file_path}")

For comprehensive library documentation, including:

  • Complete API reference for all classes and methods
  • Data models and type hints
  • Provider configuration options
  • Advanced usage patterns (filtering, custom sorting, batch processing)
  • Error handling best practices
  • 5+ detailed examples

See LIBRARY.md for full library API documentation.

Architecture & Design

See ARCHITECTURE.md for detailed architecture, design choices, and implementation learnings.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Legal Disclaimer

This tool is intended for use with content to which you have legal access. Users are responsible for complying with all applicable laws and terms of service for the supported providers.

License

MIT License - see LICENSE file for details.

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

flacfetch-0.20.0.tar.gz (164.2 kB view details)

Uploaded Source

Built Distribution

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

flacfetch-0.20.0-py3-none-any.whl (133.5 kB view details)

Uploaded Python 3

File details

Details for the file flacfetch-0.20.0.tar.gz.

File metadata

  • Download URL: flacfetch-0.20.0.tar.gz
  • Upload date:
  • Size: 164.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flacfetch-0.20.0.tar.gz
Algorithm Hash digest
SHA256 b177a5b3a990345c9b90da15137de470a59ddcb2c7caaaa3d7a72d0c255ef31e
MD5 ee0556f8eace59e6287bb10cce441c90
BLAKE2b-256 c18b2236f3b6e9f326a4009e377563849d901eb42b0be67b2f94313c3aa82a54

See more details on using hashes here.

File details

Details for the file flacfetch-0.20.0-py3-none-any.whl.

File metadata

  • Download URL: flacfetch-0.20.0-py3-none-any.whl
  • Upload date:
  • Size: 133.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flacfetch-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39989fa878ef45807711f9175d2c90dcf1ef3813e0ecf8b227966706ed19ab6d
MD5 7475b91f264a2ce471e0d71d8f7dbaf3
BLAKE2b-256 9ae9822fd0ec888b615f99b8681f02fa21030201e1bd216a166d049769ca0882

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