From 1f5ab9d66dee86af9d5168861971a918db5125ff Mon Sep 17 00:00:00 2001 From: Luke Arran Date: Fri, 9 Apr 2021 15:35:45 +0100 Subject: [PATCH] updated readme again --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1860c9c..4e98766 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# TimeToTrakt -A quick Python script to import TV Time watched episode data into Trakt.TV - using data provided by Whip Media Company via a GDPR request. +# TV Time to Trakt (Import Script) +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. # 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. # 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. -3. Episodes which have been imported are be saved to `localStorage.json` - this will let you re-run and skip to episodes which have not been imported yet. +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'. # Setup ## Get your Data -The TV Time API is request based only. In order to get access to your data, you will have to request it from TV Time's Support via a GDPR request - or just ask for it! +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! 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 @@ -22,10 +22,10 @@ The TV Time API is request based only. In order to get access to your data, you 1. Go to "Settings" under your profile 2. Select ["Your API Applications"](https://trakt.tv/oauth/applications) 3. Select "New Application" -4. Provide a random name into "Name" +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" -7. Make note of your app +7. Make note of your details to be used later. ## Setup Script ### Install Required Libraries @@ -33,7 +33,7 @@ Install the following frameworks via Pip: 1. trakt 2. tinydb ### Setup Configuration -Create a new file named `config.json`, with the below JSON (replace values with your own). +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). ``` { @@ -44,4 +44,4 @@ Create a new file named `config.json`, with the below JSON (replace values with } ``` -Then, execute the program using the `./python3 TimeToTrakt.py` - make sure to pop back and confirm selection of shows when prompted. \ No newline at end of file +Then, execute the program using `./python3 TimeToTrakt.py` - make sure to pop back during a long import to provide the correct Trakt TV Show selections. \ No newline at end of file