Skip to content

Installation

Jump to bottom
kavinthangavel edited this page Apr 21, 2025 · 7 revisions

📥 Installation Guide

This guide covers detailed installation instructions for Simkl Scrobbler across different platforms.

✅ Prerequisites

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

🚀 Standard Installation

# Install using pip
pip install simkl-scrobbler

# Initialize with your Simkl account
simkl-scrobbler init

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-scrobbler"

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-scrobbler"

🔄 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-scrobbler
pipx install simkl-scrobbler

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

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

Development Installation (from source)

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

# Install with Poetry
poetry install

# Run commands
poetry run simkl-scrobbler init
poetry run simkl-scrobbler start

⚙️ Running as a Service

Installing as a Windows Service

simkl-scrobbler install-service

This will install the application to run automatically at system startup.

Installing as a Linux Service (systemd)

simkl-scrobbler install-service

This creates and enables a systemd user service that starts automatically at login.

Installing as a macOS Launch Agent

simkl-scrobbler install-service

This creates and loads a LaunchAgent that runs the application at login.

✔️ Verifying Installation

After installation, verify that the application is properly installed:

simkl-scrobbler --version

This should display the version number of the installed application.

Clone this wiki locally