TvTimeToTrakt/README.md

62 lines
2.7 KiB
Markdown
Raw Permalink Normal View History

2021-04-09 10:46:52 -05:00
# TV Time to Trakt - Import Script
A Python script to import TV Time tracked episode and movie data into Trakt.TV - using data export provided by TV Time through a GDPR request.
2021-04-09 10:36:28 -05:00
This script was made possible by the following contributors.
<a href="https://github.com/lukearran/TvTimeToTrakt/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lukearran/TvTimeToTrakt" />
</a>
# Notes
1. The script is using limited data provided from a GDPR request - so the accuracy isn't 100%. But you will be prompted to manually pick the Trakt show/movie, when it can't be determined automatically.
2. A delay of 1 second is added between each episode/movie to ensure fair use of Trakt's API server. You can adjust this for your own import, but make sure it's at least 0.75 second to remain within the rate limit: https://trakt.docs.apiary.io/#introduction/rate-limiting
3. Episodes which have been processed will be saved to a TinyDB file `localStorage.json` - when you restart the script, the program will skip those episodes which have been marked 'imported'. Processed movies are also stored in the same file.
# Setup
## Get your Data
2021-04-09 10:46:52 -05:00
TV Time's API is not open. In order to get access to your personal data, you will have to request it from TV Time's support via a GDPR request - or maybe just ask for it, whatever works, it's your data.
2021-04-09 10:46:52 -05:00
1. Copy the template provided by [www.datarequests.org](https://www.datarequests.org/blog/sample-letter-gdpr-access-request/) into an email
2. Send it to support@tvtime.com
2021-04-09 10:46:52 -05:00
3. Wait a few working days for their team to process your request
4. Extract the data somewhere safe on your local system
## Register API Access at Trakt
1. Go to "Settings" under your profile
2. Select ["Your API Applications"](https://trakt.tv/oauth/applications)
3. Select "New Application"
4. Provide a name into "Name" e.g. John Smith Import from TV Time
5. Paste "urn:ietf:wg:oauth:2.0:oob" into "Redirect uri:"
6. Click "Save App"
2021-04-09 09:35:45 -05:00
7. Make note of your details to be used later.
## Setup Script
2021-04-09 09:18:27 -05:00
### Install Required Libraries
Install the following frameworks via Pip:
```
python -m pip install -r requirements.txt
```
2021-04-09 09:18:27 -05:00
### Setup Configuration
2021-04-09 09:35:45 -05:00
Create a new file named `config.json` in the same directory of `TimeToTrakt.py`, using the below JSON contents (replace the values with your own).
2021-04-09 09:18:27 -05:00
```
{
"CLIENT_ID": "YOUR_CLIENT_ID",
"CLIENT_SECRET": "YOUR_CLIENT_SECRET",
"GDPR_WORKSPACE_PATH": "DIRECTORY_OF_YOUR_GDPR_REQUEST_DATA",
"TRAKT_USERNAME": "YOUR_TRAKT_USERNAME"
}
```
2021-04-09 16:05:46 -05:00
Once the config is in place, execute the program using `python TimeToTrakt.py`. The process isn't 100% automated - you will need to pop back, especially with large imports, to check if the script requires a manual user input.