media_organizer/README.md

41 lines
2.1 KiB
Markdown
Raw Normal View History

2021-03-31 14:51:33 +00:00
# media_organizer
A set of python scripts to rename movies and tv shows.
This project is used and tested under Linux and is ideal to be used from something like a Raspberry Pi or a Linux based NAS. If you want to help me to get it to work under Windows, please contribute.
## moviesort
Detect movie names by querying [themoviedb.org](https://www.themoviedb.org/) API and renaming the file based on a selection of possible matches.
All data is courtesy of [The Movie Database](https://www.themoviedb.org), please contribute to this excellent database.
Movies will get renamed to this nameing style, a more flexible solution is in pending:
{movie-name} {Year}/{movie-name} {Year}.{ext}
## tvsort
Detect tv show filenames by querying [tvmaze.com](https://www.tvmaze.com/) public API to identify the show name and the episode name based on a selection of possible matches.
Episodes are named in this stylea more flexible solution is in pending:
{show-name}/Season {nr}/show-name - S{nr}E{nr} - {episode-name}.{ext}
## setup
### install
These are the none standard Python libraries in use in this project:
* [requests](https://pypi.org/project/requests/)
* Install on Arch: `sudo pacman -Qi python-request`
* Install with pip `pip install request`
* curses
* Is already installed on most linux based systems.
* On Windows: `pip install windows-curses`
### config file:
Duplicate the config.sample file to a file named *config* and set the following variables:
* `tv_downpath`: Folder path where the tv episodes get downloaded to.
* `movie_downpath`: Folder path where the movie files get downloaded to.
* `sortpath`: Empty folder the media_organizer can use to as a temporary sort path.
* `moviepath`: Folder where the organized movie files will go.
* `tvpath`: Folder where the organized tv episodes will go.
* `ext`: A space separated list of valid media file extensions to easily filter out none media related files.
* `log_file`: Path to a file to output all renaming done to keep track and check for any errors.
* `movie_db_api`: Register and get your themoviedb.com **API Key (v3 auth)** acces from [here](https://www.themoviedb.org/settings/api).