Configuration - JohanDevl/Export_Trakt_4_Letterboxd GitHub Wiki

Configuration

This guide explains how to configure Export Trakt 4 Letterboxd for use with your Trakt.tv account.

Trakt API Configuration

1. Create a Trakt Application

  1. Log in to your Trakt.tv account
  2. Go to https://trakt.tv/oauth/applications
  3. Click on "New Application"
  4. Fill in the required information:
    • Name: A name for your application (e.g., "Export Trakt 4 Letterboxd")
    • Redirect URI: urn:ietf:wg:oauth:2.0:oob
    • Description: A description of your application
  5. Check the boxes for the necessary permissions (at minimum: movies, ratings, history)
  6. Click on "Save App"
  7. Note your Client ID and Client Secret which will be used in the next step

2. Configure Your Application

Edit the config/config.toml file and enter your Trakt.tv API credentials:

[trakt]
client_id = "your_client_id_here"
client_secret = "your_client_secret_here"
api_base_url = "https://api.trakt.tv"
extended_info = "full"

Configuration File Structure

The config/config.toml file contains the following sections:

Trakt API Configuration

[trakt]
# Get these credentials at https://trakt.tv/oauth/applications
client_id = "your_client_id_here"
client_secret = "your_client_secret_here"
access_token = "" # This will be populated after first run
api_base_url = "https://api.trakt.tv"
# Options: "min", "full", "metadata", "letterboxd"
# Use "letterboxd" to enable export in Letterboxd import CSV format
extended_info = "full"

Letterboxd Export Configuration

[letterboxd]
export_dir = "exports"
# Optional: specify filenames for exports
# watched_filename = "watched.csv"
# collection_filename = "collection.csv"
# shows_filename = "shows.csv"

Export Settings

[export]
format = "csv"
date_format = "2006-01-02"
# Timezone for the export file dates (e.g. "Europe/Paris", "America/New_York")
# Leave empty to use UTC
timezone = "Europe/Paris"

Logging Configuration

[logging]
level = "info" # Possible values: debug, info, warn, error
file = "logs/export.log"

Internationalization Settings

[i18n]
default_language = "en"
language = "en" # Currently supported: "en", "fr"
locales_dir = "locales"

Configuration with Docker

If you're using Docker, mount the configuration file as a volume:

docker run -v /path/to/your/config:/app/config johanndevl/export-trakt

For more information on Docker configuration, see the Docker page.

Verifying the Configuration

To verify that your configuration is correct, run:

export-trakt

If everything is properly configured, the application should run without errors and begin exporting your data.

Extended Information Options

The extended_info setting in the Trakt configuration determines what information is fetched from the API:

  • min: Minimal information (fastest)
  • full: Complete movie information
  • metadata: Includes additional metadata
  • letterboxd: Optimizes the output for Letterboxd import format

If you're planning to import to Letterboxd, using the "letterboxd" option is recommended.