updated readme

This commit is contained in:
Luke Arran 2021-04-09 16:46:52 +01:00
parent 3d62a9aa08
commit da00fb8705

View file

@ -1,24 +1,24 @@
# TV Time to Trakt (Import Script)
# TV Time to Trakt - Import Script
![](https://loch.digital/image_for_external_apps/4342799-01.png)
A quick Python script to import TV Time tracked episode data into Trakt.TV - using data provided by Whip Media Company via a GDPR request.
A Python script to import TV Time tracked episode data into Trakt.TV - using data provided by Whip Media Company via a GDPR request.
# Issues
They'll be a few! If you come across anything then let me know in the 'Issue' section, and I'll provide help where possible.
They'll be a few! This was quickly put together within a few hours or so for personal usage. If you come across anything then let me know in the 'Issue' section, and I'll provide support where possible.
# 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, when it can't be determined automatically.
2. A delay of 5 seconds is added between each episode to ensure fair use of Trakt's servers - especially with my import of 6,500 episodes. You should adjust this for your own import.
3. Episodes which have been processed will be saved to a TinyDB file `localStorage.json` - then when you restart the script, the program will skip those episodes which have been marked 'imported'.
2. A delay of 5 seconds is added between each episode to ensure fair use of Trakt's API server - especially with my import of 6,500 episodes. You should adjust this for your own import, but make sure it's at least 1 second to remain within the rate limit.
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'.
# Setup
## Get your Data
TV Time's API is not open. So, 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!
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.
1. Copy the template provided by [www.datarequests.org](https://www.datarequests.org/blog/sample-letter-gdpr-access-request/) into an email.
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
3. Wait a few working days to process the request
4. Extract the data somewhere safe.
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
@ -32,8 +32,8 @@ TV Time's API is not open. So, in order to get access to your personal data, you
## Setup Script
### Install Required Libraries
Install the following frameworks via Pip:
1. trakt
2. tinydb
1. `pip install trakt`
2. `pip install tinydb`
### Setup Configuration
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).