Skip to main content

Synchronized lyrics in your terminal for the currently playing Spotify track

Project description

spotty

Synchronized lyrics in your terminal for the currently playing Spotify track.

  • Line-by-line sync using LRC timestamps from lrclib.net
  • Falls back to plain lyrics via lyrics.ovh if no synced lyrics found
  • Smooth display — progress interpolated between API polls (no jumping)
  • Auto-refreshes when track changes
  • Shows lyrics source (lrclib or lyrics.ovh) as a dim footer
  • Handles instrumental sections, multi-artist tracks, featured artists

spotty demo

Requirements

Installation

pip install spotty-cli

Or from source:

git clone https://github.com/Arideno/spotty
cd spotty
pip install -e .

Setup

1. Create a Spotify App

  1. Go to Spotify Developer Dashboard
  2. Click Create app
  3. Set Redirect URI to http://127.0.0.1:8888/callback
  4. Copy your Client ID

2. Configure credentials

spotty init

You will be prompted for:

Spotify Client ID: <paste your client ID>
Redirect URI [http://127.0.0.1:8888/callback]: <Enter to keep default>

Config is saved to ~/.config/spotty/config.json.

On first run after init, a browser window opens for Spotify authorization. Tokens are saved to ~/.config/spotty/tokens.json and refreshed automatically.

Usage

# Synchronized mode (default) — live updating display
spotty

# Plain lyrics — print and exit
spotty --plain

# Adjust timing if lyrics feel early or late
spotty --offset 300    # shift 300ms later
spotty --offset -200   # shift 200ms earlier

# Version
spotty --version

# Help
spotty --help

Options

Option Default Description
--plain off Show plain (non-synced) lyrics and exit
--offset MS 0 Shift lyrics by MS milliseconds. Positive = later, negative = earlier
--version Show version and exit
--help Show help and exit

Configuration

Credentials are stored in ~/.config/spotty/config.json after running spotty init.

Key Required Default Description
client_id Yes Spotify app client ID
redirect_uri No http://127.0.0.1:8888/callback OAuth callback URI — must match your Spotify app settings

To update any value, re-run spotty init.

File locations

File Purpose
~/.config/spotty/config.json Credentials
~/.config/spotty/tokens.json OAuth tokens (auto-managed)

Delete tokens.json to force re-authentication.

How it works

  1. Auth — OAuth2 PKCE flow, no client secret needed in the token exchange
  2. Now playing — polls GET /me/player/currently-playing every 500ms
  3. Lyrics — fetches LRC-timed lyrics from lrclib.net; falls back to lyrics.ovh for plain text
  4. Display — interpolates playback position between polls using the local clock for smooth highlighting

Development

# Install with dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run directly
python -m spotty.cli

Contributing

  1. Fork the repo
  2. Create a branch: git checkout -b my-feature
  3. Make changes and add tests
  4. Run pytest — all tests must pass
  5. Open a pull request

License

MIT — see LICENSE

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

spotty_cli-0.0.6.tar.gz (224.7 kB view details)

Uploaded Source

Built Distribution

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

spotty_cli-0.0.6-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file spotty_cli-0.0.6.tar.gz.

File metadata

  • Download URL: spotty_cli-0.0.6.tar.gz
  • Upload date:
  • Size: 224.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.11

File hashes

Hashes for spotty_cli-0.0.6.tar.gz
Algorithm Hash digest
SHA256 e6c9ffd695165e009f3677c3299bdb5bddd7e1a5d7108a609ddd6d878b6e7744
MD5 52a0b2fce6dc95244e7c80540a40ef71
BLAKE2b-256 58bd799fd33a783237c2960c21edafc012f3b952233131819758798bd6e80cf7

See more details on using hashes here.

File details

Details for the file spotty_cli-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: spotty_cli-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.11

File hashes

Hashes for spotty_cli-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1d1db37d9d1b7f60b76e9afdea49eac6979ad34e4ee523e5363d78fe0828f3b5
MD5 7b7aea09c808d5e3efd655a6d92e5a71
BLAKE2b-256 e09b47d75b0f2e71be4f8e03e068a20875fef8fd82ad9a926f1a318466c8913c

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