Skip to main content

Search and download music from YouTube Music with lyrics

Project description

Kikusan

Search and download music from YouTube Music with lyrics.

Features

  • Search YouTube Music
  • Download audio in OPUS/MP3/FLAC format
  • Playlist support (download entire playlists)
  • Quick download (search and download first match)
  • Automatic lyrics fetching from lrclib.net (LRC format)
  • CLI and web interface
  • Docker support

Installation

uv sync

Usage

CLI

# Search for music
kikusan search "Bohemian Rhapsody"

# Download by video ID
kikusan download bSnlKl_PoQU

# Download by URL
kikusan download --url "https://music.youtube.com/watch?v=bSnlKl_PoQU"

# Search and download first match
kikusan download --query "Bohemian Rhapsody Queen"

# Download entire playlist
kikusan download --url "https://music.youtube.com/playlist?list=..."

# Custom filename format
kikusan download bSnlKl_PoQU --filename "%(title)s"

# Options
kikusan download bSnlKl_PoQU --output ~/Music --format mp3

Web Interface

kikusan web
# Open http://localhost:8000

Docker

docker compose up -d
# Open http://localhost:8000

Configuration

Environment variables:

Variable Default Description
KIKUSAN_DOWNLOAD_DIR ./downloads Download directory
KIKUSAN_AUDIO_FORMAT opus Audio format (opus, mp3, flac)
KIKUSAN_FILENAME_TEMPLATE %(artist,uploader)s - %(title)s Filename template (yt-dlp format)
KIKUSAN_WEB_PORT 8000 Web server port

Requirements

  • Python 3.12+
  • ffmpeg (for audio processing)

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

kikusan-0.1.0.tar.gz (70.3 kB view details)

Uploaded Source

Built Distribution

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

kikusan-0.1.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kikusan-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3a498d13ac28c70959d9d2c32ed8531314ce9dd22d44d44e425de5501db19f1b
MD5 06b8e793f4ffa53a89ef5909321e0df0
BLAKE2b-256 5a7588264d75484e210ddf537338110dc42e6e93b63cfea496152ff6093eca1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for kikusan-0.1.0.tar.gz:

Publisher: publish.yml on dadav/kikusan

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

File details

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

File metadata

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

File hashes

Hashes for kikusan-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 06d5780b6eae2a9c92276973d01199cbef8dfa82a3e84d405633886c5cf9acf8
MD5 b5d9a0309c073e3983e3ddb6c8b316ef
BLAKE2b-256 05879b82bf2cb61910eb327f20201c8acb7bbb7e9e81cc267bba097472c2725f

See more details on using hashes here.

Provenance

The following attestation bundles were made for kikusan-0.1.0-py3-none-any.whl:

Publisher: publish.yml on dadav/kikusan

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