Installation

📥 Installation Guide

This guide covers detailed installation instructions for Media Player Scrobbler for SIMKL across different platforms.

✅ Prerequisites

• Python 3.9 or higher
• pip (Python package manager)

🚀 Standard Installation

# Install using pip
pip install simkl-mps

# Initialize with your Simkl account
simkl-mps s    # or: simkl-mps start

After Installation Setup the Web Interface in Supported Players

The initialization process will guide you through authentication with Simkl using a device code. Simply visit the provided URL and enter the code to link the application to your Simkl account.

💻 Platform-Specific Requirements

Windows

No additional requirements.

macOS

For full functionality:

# Install optional dependencies (recommended)
pip install "simkl-mps"

Linux

For window detection and full functionality:

# Ubuntu/Debian
sudo apt install wmctrl xdotool plyer

# Fedora
sudo dnf install wmctrl xdotool plyer

# Arch Linux
sudo pacman -S wmctrl xdotool plyer

# Install optional dependencies
pip install "simkl-mps"

🔄 Alternative Installation Methods

Using pipx (Isolated Environment)

pipx installs packages in isolated environments while making their entry points globally available:

# Install pipx if not already installed
python -m pip install --user pipx
python -m pipx ensurepath  # Restart terminal after this

# Install simkl-mps
pipx install simkl-mps

# For macOS specific dependencies
pipx install simkl-mps --extras macos

# For Linux specific dependencies
pipx install simkl-mps --extras linux

Development Installation (from source)

# Clone repository
git clone https://github.com/kavinthangavel/simkl-mps.git
cd simkl-mps

# Install with Poetry
poetry install

# Run commands
poetry run simkl-mps i    # or: init
poetry run simkl-mps s    # or: start

✔️ Verifying Installation

After installation, verify that the application is properly installed:

simkl-mps -v    # or: --version
simkl-mps V     # or: version

This will display version information about the installed application.

🚀 Starting the Application

There are two ways to run the application:

1. Background Mode (recommended for daily use):

simkl-mps s    # or: simkl-mps start

This runs the application detached in the background. You can safely close the terminal.

2. Interactive Mode (useful for debugging):

simkl-mps t    # or: simkl-mps tray

This runs the application attached to the terminal, showing logs. The application will stop when you close the terminal.