PlexWasher/README.md

52 lines
1.5 KiB
Markdown

# PlexWasher
A simple command line to remove media from plex
## Description
This tool will query a Tautulli server to get the path of all files for a media that was not not been watched for a given period.
The list will then be written to a file in case the user want to double check before deleting all the listed files.
This tool supports:
- selection of period a media is not beeing watched before deleting it.
- whitelist of files to prevent the deletion of a media even if the not watched period is exeeded.
## Getting Started
### Dependencies
* python3.10 or newer
### Installing
* Download the source code
```
git clone https://git.antoinesanchez.fr/Akiya/PlexWasher.git # or download the ZIP from https://git.antoinesanchez.fr/Akiya/PlexWasher/archive/main.zip and extract it
```
* Rename 'config.exemple.ini' to 'config.ini' and modify it to set the correct informations
### Executing program
* CMD description:
```
usage: plexwasher.py [-h] [-v] [-g] [-d] [-o OUTPUT]
options:
-h, --help show this help message and exit
-v, --verbose Print lots of debugging statements
-g, --get Get the list of files to delete and stores the list in a file
-d, --delete Read a file listing unwanted files, delete the unwanted files and its parent folders if empty.
-o OUTPUT, --output OUTPUT
Change the default output file.
```
* Exemple:
```
./plexwasher.py --get
```
## License
This project is licensed under the Apache-2.0 License - see the LICENSE file for details