Metadata-Version: 2.1
Name: plex-tvdb-alt-orderer
Version: 0.2.0
Summary: A utility that applies alternate TVDB orders to Plex.
Author: bpoxy
Project-URL: Homepage, https://github.com/bpoxy/plex-tvdb-alt-orderer
Project-URL: Bug Tracker, https://github.com/bpoxy/plex-tvdb-alt-orderer
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Video
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: inquirer
Requires-Dist: plexapi
Requires-Dist: progress
Requires-Dist: termcolor
Requires-Dist: tvdb-v4-official
Requires-Dist: validators

# plex-tvdb-alt-orderer
A utility that applies alternate TVDB orders to Plex.  
It was specifically created to apply the Money Heist Netflix order but can be used for any show/order combination.

_NOTE: A TVDB API subscription is required._

## Usage
### Interactive
By default, this application runs in interactive mode and will prompt the user for all necessary information.
However, all of this information can also be supplied via the CLI or environment variables.

#### Example (User/Password)
```
B:\> plex-tvdb-alt-orderer
[?] Enter your Plex server name (user/password authentication) or URL (token authentication): CoolGuyServer
[?] Enter your Plex username: coolguy
[?] Enter your Plex password: ********************
[?] Enter the name of the show: Money Heist
[?] Enter your TVDB subscriber PIN: ABC1234
[?] Select the order to apply: Alternate Order
   Aired Order
   DVD Order
   Absolute Order
 > Alternate Order
   Regional Order
   Alternate DVD Order

[?] Select the season to update: Entire Series
 > Entire Series
   Season 1
   Season 2
   Season 3
   Season 4
   Season 5

Updating Plex |################################| 48/48
```

#### Example (Token)
```
B:\> plex-tvdb-alt-orderer
[?] Enter your Plex server name (user/password authentication) or URL (token authentication): http://127.0.0.1:32400/
[?] Enter your Plex token: a9vuu9aklnKisJy4kmsT
[?] Enter the name of the show: Money Heist
[?] Enter your TVDB subscriber PIN: ABC1234
[?] Select the order to apply: Alternate Order
   Aired Order
   DVD Order
   Absolute Order
 > Alternate Order
   Regional Order
   Alternate DVD Order

[?] Select the season to update: Entire Series
 > Entire Series
   Season 1
   Season 2
   Season 3
   Season 4
   Season 5

Updating Plex |################################| 48/48
```

### CLI
```
Usage: plex-tvdb-alt-orderer [OPTIONS]

Options:
  --plex-library TEXT   Your Plex TV show library name. Omit to use the
                        PLEX_LIBRARY environment variable, choose from a list
                        interactively or if your Plex server has a sole TV
                        show library.
  --plex-password TEXT  Your Plex password. Omit to use the PLEX_PASSWORD
                        environment variable or enter interactively.
  --plex-server TEXT    Your Plex server name (user/password authentication)
                        or URL (token authentication). Omit to use the
                        PLEX_SERVER environment variable or enter
                        interactively.
  --plex-show TEXT      The name of the show in Plex. Omit to use the
                        PLEX_SHOW environment variable or enter interactively.
  --plex-token TEXT     Your Plex token. Omit to use the PLEX_TOKEN
                        environment variable or enter interactively.
  --plex-user TEXT      Your Plex username. Omit to use the PLEX_USER
                        environment variable or enter interactively.
  --season INTEGER      The season to update (-1 to update the entire
                        series). Omit to use the SEASON environment variable
                        or enter interactively.
  --tvdb-order TEXT     The TVDB order name (as specified for API-connected
                        systems). Omit to use the TVDB_ORDER environment
                        variable or choose from a list interactively.
  --tvdb-pin TEXT       Your TVDB subscriber PIN. Omit to use the TVDB_PIN
                        environment variable or enter interactively.
  --help                Show this message and exit.
```

#### Example
```
plex-tvdb-alt-orderer --plex-server "CoolGuyServer" --plex-user coolguy --plex-password P@$$W0RD --plex-show "Money Heist" --season -1 --tvdb-pin ABC1234 --tvdb-order "Alternate Order"
```

### Environment Variables
| Name | Description |
| ------------- | ------------- |
| `ALT_ORDERER_PLEX_LIBRARY` | Your Plex TV show library name. |
| `ALT_ORDERER_PLEX_PASSWORD` | Your Plex password. |
| `ALT_ORDERER_PLEX_SERVER` | Your Plex server name (user/password authentication) or URL (token authentication). |
| `ALT_ORDERER_PLEX_SHOW` | The name of the show in Plex. |
| `ALT_ORDERER_PLEX_TOKEN` | Your Plex token. |
| `ALT_ORDERER_PLEX_USER` | Your Plex username. |
| `ALT_ORDERER_SEASON` | The season to update (-1 to update the entire series). |
| `ALT_ORDERER_TVDB_ORDER` | The TVDB order name (as specified for API-connected systems). |
| `ALT_ORDERER_TVDB_PIN` | Your TVDB subscriber PIN. |

_NOTE: CLI parameters take precedence over environment variables._

### Additional Information
If the show name (entered interactively or via the CLI or environment variable) matches multiple Plex shows, the user will be prompted to select one:
```
[?] Select the show to update: The 10th Kingdom
 > The 10th Kingdom
   Animal Kingdom (2016)
   Kingdom
   Kingdom (2014)
   The Last Kingdom
```
