junior/PlexDev
junior/PlexDev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add descriptions for additional config values

Browse Source
This commit is contained in:
Junior 2023-09-15 17:04:32 +00:00
parent 1b60e04fd7
commit c8523d870b
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -6,13 +6,21 @@ Here lies several scripts, mostly in python, for doing some simple but useful th
In each folder there should be a file named `apiconfig-default.py`. This file __must__ be renamed to `apiconfig.py` and the values inside the file must be edited to reflect your environment.
Settings to be edited:
* __url =__ : This should be set to the URL for your service (i.e. `http://plex.local.lan:32400`). Present in all folders.
* __apikey =__ : This should be set to the API Key for the service. Each service provides this key in a different location so refer to the documentation for the particular service to locate this value. Present in all folders.
* __mediafolder =__ : This is the top level folder for the media (i.e. videos, etc.) relevant to each service. Currently present only for PlexDev
Settings to be edited for all projects/folders:
* __url =__ : This should be set to the URL for your service (i.e. `http://plex.local.lan:32400`).
* __apikey =__ : This should be set to the API Key for the service. Each service provides this key in a different location so refer to the documentation for the particular service to locate this value.
### PlexDev
Settings unique to this project/folder:
* __mediafolder =__ : This is the top level folder for the media (i.e. videos, etc.) relevant to each service.
* __libraryname =__ : This is the name of the Plex library in which the programs should operate.
* __colmap = {}__ : This is a dictionary containing entries mapping folder names to collection names. Each top level folder inside "mediafolder" you wish to have collections created/maintained for should be entered here. Each entry must be on a new separate line between the `{` and `}` lines and all but the last line must have a trailer comma `,`.
- A folder named "SciFi" for which you want to have a collection named "Sci-Fi" would look like this:
- `'SciFi': 'Sci-Fi'`
This is the top level repository folder and contains scripts meant to be used on the PlexAPI.
* __updatecoll.py__ : This program creates collections for each top level movie folder and ensures each movie is a member of a collection named based on the main folder in which it resides (i.e. movies in the Scary/ folder are added to the "Scary" collection). This value __must__ have a trailing slash.