https://github.com/cecobask/imdb-trakt-sync

Automatic sync from IMDb to Trakt (watchlist, lists, ratings and history) using GitHub actions.
https://github.com/cecobask/imdb-trakt-sync

github-actions golang imdb trakt webscraping

Last synced: 6 months ago
JSON representation

Automatic sync from IMDb to Trakt (watchlist, lists, ratings and history) using GitHub actions.

• Host: GitHub
• URL: https://github.com/cecobask/imdb-trakt-sync
• Owner: cecobask
• License: mit
• Created: 2022-04-24T18:58:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-02-08T21:37:02.000Z (8 months ago)
• Last Synced: 2025-02-08T22:25:31.634Z (8 months ago)
• Topics: github-actions, golang, imdb, trakt, webscraping
• Language: Go
• Homepage:
• Size: 801 KB
• Stars: 104
• Watchers: 9
• Forks: 239
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
[![sync](https://github.com/cecobask/imdb-trakt-sync/actions/workflows/sync.yaml/badge.svg)](https://github.com/cecobask/imdb-trakt-sync/actions/workflows/sync.yaml)

[![quality](https://github.com/cecobask/imdb-trakt-sync/actions/workflows/quality.yaml/badge.svg)](https://github.com/cecobask/imdb-trakt-sync/actions/workflows/quality.yaml)

[![codecov](https://codecov.io/gh/cecobask/imdb-trakt-sync/graph/badge.svg)](https://codecov.io/gh/cecobask/imdb-trakt-sync)

# imdb-trakt-sync



Command line application that can sync [IMDb](https://www.imdb.com/) and [Trakt](https://trakt.tv/dashboard) user data - watchlist, lists, ratings and optionally history.  

To achieve its goals the application is using the [Trakt API](https://trakt.docs.apiary.io/) 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](.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](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](https://github.com/cecobask/imdb-trakt-sync/fork) to your account

2. Create a [Trakt App](https://trakt.tv/oauth/applications). 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](config.yaml) 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](https://git-scm.com/downloads) and [Go](https://go.dev/doc/install)

2. Clone the repository: `git clone git@github.com:cecobask/imdb-trakt-sync.git`

3. Create a [Trakt App](https://trakt.tv/oauth/applications). 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`