search

cecobask / imdb-trakt-sync

Automatic sync from IMDb to Trakt (watchlist, lists, ratings and history) using GitHub actions.
MIT License
97 stars 229 forks source link
github-actions golang imdb trakt webscraping

readme

sync quality codecov

imdb-trakt-sync

logo

Command line application that can sync IMDb and Trakt user data - watchlist, lists, ratings and optionally history.
To achieve its goals the application is using the Trakt API and web scraping.
Keep in mind that this application is performing one-way sync from IMDb to Trakt. This means that any changes made on IMDb will be reflected on Trakt, but not the other way around.

Usage

The application can be setup to run automatically, based on a custom schedule (default: once every 12 hours) using GitHub Actions or locally on your machine.
Workflow schedules can be tweaked by editing the .github/workflows/sync.yaml file and committing the changes.
There are 3 possible modes to run this application and more details can be found in the config.yaml file.
Follow the relevant section below, based on how you want to use the application.

Run the application using GitHub Actions

  1. Fork the repository to your account
  2. Create a Trakt App. Use urn:ietf:wg:oauth:2.0:oob as redirect uri
  3. Configure the application:
    • Open your fork repository on GitHub
    • Create an individual repository secret for each configuration parameter: Settings > Secrets and variables > Actions > New repository secret
    • The secret names should match the configuration parameter paths (delimited by underscore). For example, to configure your Trakt email, the secret name should be TRAKT_EMAIL
  4. Allow GitHub Actions on your fork repository: Settings > Actions > General > Allow all actions and reusable workflows
  5. Enable the sync workflow: Actions > Workflows > sync > Enable workflow
  6. Run the sync workflow manually: Actions > Workflows > sync > Run workflow
  7. From now on, GitHub Actions will automatically trigger the sync workflow

Run the application locally

  1. Install Git and Go
  2. Clone the repository: git clone git@github.com:cecobask/imdb-trakt-sync.git
  3. Create a Trakt App. Use urn:ietf:wg:oauth:2.0:oob as redirect uri
  4. Open a terminal window in the repository folder and then:
    • Build the syncer: make build
    • Configure the syncer: make configure
    • Run the syncer: make sync