spotify_monitor

Powerful real-time tracker for Spotify friend music activity: monitor listening habits, auto-sync playback to your local Spotify client, detect skipped tracks and receive instant notifications for every beat your friends play.

🚀 Quick Install & Run

Python from PyPI

New to Python or unsure what is installed? Follow the Python install walkthrough first.

pip install spotify_monitor

Run setup for friend activity mode (Spotify friend's completed plays, activity status and listening session):

spotify_monitor --setup

Or for Last.fm scrobble health mode (checks whether plays from your Spotify account reach your Last.fm profile):

spotify_monitor --setup-scrobble-health

Docker image - fastest container setup

The Docker commands below run Friend Activity setup. For Last.fm scrobble health, replace the final --setup with --setup-scrobble-health.

macOS or Windows

Use a macOS shell or Windows PowerShell with a Docker-compatible runtime that provides the docker CLI.

docker run --rm --pull=always -it --init -v "${PWD}:/data:z" misiektoja/spotify-monitor:latest --setup

In Windows Command Prompt replace ${PWD} with %cd% above.

Linux

Run the container with your numeric user and group IDs (--user "$(id -u):$(id -g)" below). This lets the container write files that your host account can edit.

docker run --rm --pull=always -it --init --user "$(id -u):$(id -g)" -v "$PWD:/data:z" misiektoja/spotify-monitor:latest --setup

Docker Compose - shorter recurring commands

Download the Compose file:

curl -fsSLO https://raw.githubusercontent.com/misiektoja/spotify_monitor/refs/heads/main/docker-compose.yml

Linux container engine requires to export your numeric user ID and group ID so files created in the current directory belong to you instead of root.

export SPOTIFY_MONITOR_UID="$(id -u)"
export SPOTIFY_MONITOR_GID="$(id -g)"

Docker-compatible runtimes on macOS and Windows normally do not need these values.

Run setup wizard:

docker compose run --rm --pull=always spotify_monitor --setup

For the manual single-file method, optional extras and upgrade commands for every method, see Installation.

Features

🔍 Real-time Tracking

• Friend Activity: Monitor songs listened to by Spotify users in real time.
• Scrobble Health: Detect and alert when Spotify scrobbles stop showing up on Last.fm.
• Presence Detection: Detect when friends get online or offline.
• Session Stats: Display duration, track counts and songs on loop.

🎮 Playback Control

• Auto-Sync: Automatically play friends' songs in your local Spotify client.
• Smart Pause: Pause or switch tracks when the monitored user goes offline.
• Crossfade Support: Detect and annotate crossfaded songs during transitions.

📊 Rich Insights

• Track Context: View playlist, artist and album info with clickable URLs.
• Skip Detection: Identify exactly when and how long a song was played.
• Global Search: Instant links to Spotify, YouTube Music, Apple Music, Tidal, lyrics and more.
• Coloured Output: Readable terminal colours with a customizable theme, while log files stay plain text.

🔔 Smart Notifications

• Multi-Channel: Instant alerts via Email and Webhooks (Discord, ntfy etc.).
• Detailed Alerts: Choose activity, tracked-song, every-song, loop and error alerts.
• Session Summaries: Receive detailed reports when a friend finishes a session.
• Error Reporting: Be notified if the monitoring process hits a snag.

⚙️ Power Features

• Auth Flexibility: Cookie or Desktop Client access with automatic web-player metadata fallback and optional legacy OAuth app support.
• CSV Logging: Save every listened song with full timestamps to a CSV file.
• Flexible Config: Support for files, dotenv and environment variables.
• Signal Control: Manage the running script via system signals (macOS/Linux).
• Docker Ready: Run through Docker Hub, Docker Compose or a local image with persistent configuration, secrets and output.

For pause and resume tracking, progress indicators and offline mode, see lastfm_monitor.

For Spotify profile and playlist change tracking, see spotify_profile_monitor.

For Spotify Web Player token and TOTP utilities, see Debugging Tools.

Before Monitoring

Spotify only shows a person's listening activity when both of these conditions are met:

1. The Spotify account used by Spotify Monitor follows the person you want to monitor.
2. That person has enabled listening activity sharing in Spotify.

The setup wizard checks whether the monitoring account follows the target. It can send the follow request after you confirm. To follow manually, open the target's profile in the Spotify desktop or mobile app. You can use Share > Copy link to profile and paste the complete link into the wizard. You do not need to extract the user ID. See Following the Monitored User.

Common Commands

Use Quick Install & Run above for first-time setup. The table uses PyPI commands. For manual script, direct Docker and Docker Compose equivalents, see Run Individual Commands.

Running the tool with no arguments offers the wizard if you have not saved a target. If a target is already saved, it starts monitoring that target.

For authentication, saved targets, configuration backups and setup recovery, see the full Setup & First Run guide.

For browser profiles, manual cookie extraction, Docker authentication, email and webhook setup, see Configuration. For notification choices, playback controls and output files, see Usage.

Documentation

Full documentation is available at misiektoja.github.io/spotify_monitor:

• Installation - PyPI, manual script, Docker installation and upgrades
• Setup & First Run - setup wizard, authentication and first run
• Configuration - Spotify login, targets, SMTP, webhooks and secrets
• Usage - command formats, monitoring, container operation, notifications, playback and output
• Troubleshooting - the --doctor self-check and logging levels
• Debugging Tools - TOTP token testing and secret extraction

Change Log

See RELEASE_NOTES.md for details.

Contributing

Bug reports, documentation fixes and code contributions are welcome. See CONTRIBUTING.md for the development setup, the checks CI enforces and what a change needs before it is merged. Participation is covered by the Code of Conduct.

Security

Report a suspected vulnerability privately through GitHub security advisories, never as a public issue. SECURITY.md covers the reporting process, the supported versions and the security posture of stored secrets, configuration loading and local playback.

Maintainers

• misiektoja (@misiektoja)
• tomballgithub (@tomballgithub)

License

Licensed under GPLv3. See LICENSE. Dependency licenses are listed in THIRD_PARTY_NOTICES.md.

Support

If the project is useful to you, you can support its development through GitHub Sponsors or Buy Me a Coffee.