Installation

Installation Steps

1. Open a terminal/powershell.
2. Ensure you have Python 3.9 or higher installed, and in your system PATH.
   • Check by running python --version
3. Ensure pip is installed.
   • Check: pip --version
4. Install pipx:
   • MacOS:

     brew install pipx
     pipx ensurepath

   • Linux and windows (replace python3 with python if the commands fail):

     python3 -m pip install --user pipx
     python3 -m pipx ensurepath

     (Windows users may require a reboot after this step)
5. Run pipx install trakt-scrobbler
   • Check out the Variations section for extra modifications to the installation.
   • You will now have the trakts command available!
6. Run trakts init
   • You will be prompted to select the players to be monitored, and authorize the app to access the Trakt.tv API on your behalf. Follow the steps on screen to finish the process.
   • It is okay if you mess up at this step. It is completely safe to re-run the command if you need to restart from the top.

Next Steps

1. Players Setup (Mandatory!)
2. Read FAQ (Recommended)
3. trakts Command Usage (So you don't keep re-running trakts init every time you need to change the whitelist (there's a better way!), among other things)

Updating

The scrobbler keeps getting updated with bug fixes and new features. Make sure to regularly (once a month should be enough) run the update command to fetch the latest changes. See How to update.

Variations

In the following commands, replace install with install --force --pip-args='--force-reinstall' if you have already installed the scrobbler and want to upgrade.

Installing other versions

• To install a beta (non-stable) version: pipx install --pip-args="--pre" trakt-scrobbler

• To install an unreleased version, directly from the master branch: pipx install git+https://github.com/iamkroot/trakt-scrobbler.git@master

SOCKS Proxy support

In step 5, use pipx install "trakt-scrobbler[socks]". See Configuration Reference section to see how to set up the proxy.