Skip to main content

A media file organiser

Project description

pypi travis_ci coverage licence style black

mnamer

mnamer (media renamer) is an intelligent and highly configurable media organization utility. It parses media filenames for metadata, searches the web to fill in the blanks, and then renames and moves them.

Currently it has integration support with TVDb and TvMaze for television episodes and TMDb and OMDb for movies.

Documentation

Check out the wiki page for more details.

💾 Installation

$ pip3 install --user mnamer

🤖 Automation

$ docker pull jkwill87/mnamer

✍️ Formatting

Using the episode-directory, episode-format, movie-directory, or movie-format settings you customize how your files are renamed. Variables wrapped in braces {} get substituted with of parsed values of template field variables.

🌐 Internationalization

Language is supported by the default TMDb and TVDb providers. You can use the --language setting to set the language used for templating.

mnamer also supports subtitle files (.srt, .idx, .sub). It will use the format pattern used for movie or episode media files with its extension prefixed by its 2-letter language code.

🧰 Settings

USAGE: mnamer [preferences] [directives] target [targets ...]

POSITIONAL:
  [TARGET,...]: media file file path(s) to process

PARAMETERS:
  The following flags can be used to customize mnamer's behaviour. Their long
  forms may also be set in a '.mnamer-v2.json' config file, in which case cli
  arguments will take precedence.

  -b, --batch: process automatically without interactive prompts
  -l, --lower: rename files using lowercase characters
  -r, --recurse: search for files within nested directories
  -s, --scene: use dots in place of alphanumeric chars
  -v, --verbose: increase output verbosity
  --hits=<NUMBER>: limit the maximum number of hits for each query
  --ignore=<PATTERN,...>: ignore files matching these regular expressions
  --language=<LANG>: specify the search language
  --mask=<EXTENSION,...>: only process given file types
  --no-guess: disable best guess; e.g. when no matches or network down
  --no-overwrite: prevent relocation if it would overwrite a file
  --no-style: print to stdout without using colour or unicode chars
  --movie-api={*tmdb,omdb}: set movie api provider
  --movie-directory: set movie relocation directory
  --movie-format: set movie renaming format specification
  --episode-api={tvdb,*tvmaze}: set episode api provider
  --episode-directory: set episode relocation directory
  --episode-format: set episode renaming format specification

DIRECTIVES:
  Directives are one-off arguments that are used to perform secondary tasks
  like overriding media detection. They can't be used in '.mnamer-v2.json'.

  -V, --version: display the running mnamer version number
  --clear-cache: clear request cache
  --config-dump: prints current config JSON to stdout then exits
  --config-ignore: skips loading config file for session
  --config-path=<PATH>: specifies configuration path to load
  --id-imdb=<ID>: specify an IMDb movie id override
  --id-tmdb=<ID>: specify a TMDb movie id override
  --id-tvdb=<ID>: specify a TVDb series id override
  --id-tvmaze=<ID>: specify a TvMaze series id override
  --no-cache: disable request cache
  --media={movie,episode}: override media detection
  --test: mocks the renaming and moving of files

Parameters can either by entered as command line arguments or from a config file named .mnamer-v2.json.

Contributions

Community contributions are a welcome addition to the project. In order to be merged upsteam any additions will need to be formatted with black for consistency with the rest of the project and pass the continuous integration tests run against each PR. Before introducing any major features or changes to the configuration api please consider opening an issue to outline your proposal.

Bug reports are also welcome on the issue page. Please include any generated crash reports if applicable. Feature requests are welcome but consider checking out if it is in the works first to avoid duplication.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mnamer-2.4.2.tar.gz (30.5 kB view details)

Uploaded Source

Built Distribution

mnamer-2.4.2-py2.py3-none-any.whl (31.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file mnamer-2.4.2.tar.gz.

File metadata

  • Download URL: mnamer-2.4.2.tar.gz
  • Upload date:
  • Size: 30.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for mnamer-2.4.2.tar.gz
Algorithm Hash digest
SHA256 61620cf167e98ab590ee273dd0d73e55249f6692ae1a584d453436f733bd7ef4
MD5 493331a4b434ad8ac7af7c5427d3b06e
BLAKE2b-256 44c50d176edb8fe6560fbd9c5a7699495f2068936b8c727f03612aef3b678117

See more details on using hashes here.

File details

Details for the file mnamer-2.4.2-py2.py3-none-any.whl.

File metadata

  • Download URL: mnamer-2.4.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 31.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

File hashes

Hashes for mnamer-2.4.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1f413ac799ab09dc6ea2eb36585f175f5074e44b221cc63d2923a1b56230ded2
MD5 f755489e88c71757ba9481e145926e9f
BLAKE2b-256 e2f2d6c6be6a2c5aa2b8f155e096ed342130efe0ccad5facd5abf7475c724fbb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page