Wording fixes.

pull/23/head
desimaniac 7 years ago
parent 17087a02f0
commit 9cf81ef0f3

@ -1,4 +1,4 @@
# Traktarr
# traktarr
Script to add new shows & movies to Sonarr/Radarr based on Trakt lists.
Types of Trakt lists supported:
@ -32,7 +32,7 @@ Types of Trakt lists supported:
## 1. Base Install
Install Traktarr to be run with `traktarr` command.
Install traktarr to be run with `traktarr` command.
1. `cd /opt`
2. `sudo git clone https://github.com/l3uddz/traktarr`
@ -46,10 +46,10 @@ Install Traktarr to be run with `traktarr` command.
## 2. Create app authentication
1. Create a Trakt application by going [here](https://trakt.tv/oauth/applications/new)
2. Enter a name for your application; for example `Traktarr`
2. Enter a name for your application; for example `traktarr`
3. Enter `urn:ietf:wg:oauth:2.0:oob` in the `Redirect uri` field.
4. Click "SAVE APP".
5. Open the Traktarr configuration file `config.json` and insert the Client ID in the `client_id` and the Client Secret in the `client_secret`, like this:
5. Open the traktarr configuration file `config.json` and insert the Client ID in the `client_id` and the Client Secret in the `client_secret`, like this:
```
{
@ -83,16 +83,6 @@ Repeat the following steps for every user you want to authenticate:
You've now authenticated the user.
You can repeat this process for as many users as you like.
## 4. Setup Schedule
To have Traktarr get Movies and Shows for you automatically, on set interval.
1. `sudo cp /opt/traktarr/systemd/traktarr.service /etc/systemd/system/`
2. `sudo systemctl daemon-reload`
3. `sudo systemctl enable traktarr.service`
4. `sudo systemctl start traktarr.service`
# Configuration
@ -226,9 +216,11 @@ To have Traktarr get Movies and Shows for you automatically, on set interval.
## Automatic
Used for automatic / scheduled Traktarr tasks.
Used for automatic / scheduled traktarr tasks.
Movies can be run on a separate schedule from Shows.
Movies can be run on a separate schedule then from Shows.
_Note: These settings are only needed if you plan to use traktarr on a schedule (i.e. manually (via CLI) only) - see [Usage](#usage) section.._
```json
"automatic": {
@ -252,7 +244,7 @@ Movies can be run on a separate schedule from Shows.
},
```
`interval` - specify how often (in hours) to run Traktarr task.
`interval` - specify how often (in hours) to run traktarr task.
`anticipated`, `popular`, `trending`, `boxoffice` (movies only) - specify how many items from each Trakt list to find.
@ -262,7 +254,8 @@ Movies can be run on a separate schedule from Shows.
### Personal Watchlists
The watchlist task can be scheduled with a differtent item limit for every (authenticated) user.*
The watchlist task can be scheduled with a differtent item limit for every (authenticated) user.
So for every user, you will add: `"username": limit` to the watchlist key. For example:
@ -563,9 +556,9 @@ Must not contain:
Tags: AMZN
```
### Traktarr
### traktarr
Finally, we will edit the Traktarr config and assign the `AMZN` tag to certain networks.
Finally, we will edit the traktarr config and assign the `AMZN` tag to certain networks.
```json
"tags": {
@ -611,8 +604,19 @@ Trakt Authentication info:
# Usage
## Automatic (Scheduled)
## General
To have traktarr get Movies and Shows for you automatically, on set interval.
1. `sudo cp /opt/traktarr/systemd/traktarr.service /etc/systemd/system/`
2. `sudo nano /etc/systemd/system/traktarr.service` and edit user/group to match yours.
2. `sudo systemctl daemon-reload`
3. `sudo systemctl enable traktarr.service`
4. `sudo systemctl start traktarr.service`
## Manual
### General
```
traktarr
@ -633,11 +637,11 @@ Commands:
movies Add new movies to Radarr.
run Run in automatic mode.
shows Add new shows to Sonarr.
trakt_authentication Authenticate Traktrarr to index your personal...
trakt_authentication Authenticate traktarr.
```
## Movies
### Movies
```
traktarr movies --help
@ -663,11 +667,11 @@ Options:
--notifications Send notifications.
--authencate-user TEXT Specify which user to authenticate with to
retrieve Trakt lists. Default: first user in the
config
config.
```
## Shows
### Shows
```
Usage: traktarr shows [OPTIONS]
@ -688,7 +692,7 @@ Options:
--notifications Send notifications.
--authencate-user TEXT Specify which user to authenticate with to
retrieve Trakt lists. Default: first user in the
config
config.
--help Show this message and exit.
```

@ -261,7 +261,7 @@ def shows(list_type, add_limit=0, add_delay=2.5, genre=None, folder=None, no_sea
@click.option('--no-search', is_flag=True, help='Disable search when adding movies to Radarr.')
@click.option('--notifications', is_flag=True, help='Send notifications.')
@click.option('--authenticate-user',
help='Specify which user to authenticate with to retrieve Trakt lists. Default: first user in the config')
help='Specify which user to authenticate with to retrieve Trakt lists. Default: first user in the config.')
def movies(list_type, add_limit=0, add_delay=2.5, genre=None, folder=None, no_search=False, notifications=False,
authenticate_user=None):
from media.radarr import Radarr

Loading…
Cancel
Save