Skip to main content

Rename TV show Media files with Respective episode Titles/Names.

Project description

Intro

Shownamer - Media Renamer

A lightweight Python CLI tool that renames TV show episode video files by fetching their actual episode titles. Movies are not supported, All TV Shows and Sitcoms are supported.

[!NOTE] Fetches details and Names from TVmaze.

Features

  • Automatically detects and renames files like:

    Before: Malcolm in the Middle S01E10.mkv
    After: Malcolm in the Middle S01E10 - Stock Car Races.mkv
    
  • Fetches episode titles using the free TVmaze API.

  • Cleans illegal filename characters automatically.

  • CLI flags for:

    • Custom directory
    • File extension filter
    • Available Show Names
    • Dry-run mode
    • Verbose logging

Usage

Requirements

  • Python 3.6+

Install requirements:

pip install shownamer

Run the script

shownamer --help

Available Flags

Flag Description
--dir Directory to scan for files (default: current working directory)
--ext File extensions to consider (default: .mkv, .mp4, .avi, .mov, .flv)
--dry-run Show what would be renamed, without actually renaming any files
--verbose Show skipped files, errors, and debug output
--name List detected show names along with season and episode counts
--format Custom rename format using placeholders: {name}, {season}, {episode}, {title}
--version Print the tool version and exit

Example Usage

# Rename all valid video files in the current directory
shownamer

# Specify a custom directory
shownamer --dir "/path/to/your/episodes"

# Preview changes without renaming files
shownamer --dry-run

# Show detected show names with season/episode stats
shownamer --name

# Limit to specific extensions
shownamer --ext mkv mp4 avi

# Verbose mode (shows skipped files, debug info)
shownamer --verbose

Filename Formats

{name} # show name
{season} # season number (as integer)
{episode} # episode number (as integer)
{title} # episode title (sanitized for filesystem)
shownamer --format "{name} - S{season:02}E{episode:02} - {title}" # Default Format

# Other Examples
shownamer --format "{title} [{name} S{season:02}E{episode:02}]" # Title-first format
shownamer --format "E{episode:02} - {title}" # Episode code only
shownamer --format "{name} - {title}" # Name only

The script supports the following file name pattern:

Malcolm in the Middle S01E10.mkv
Malcolm_in_the_Middle_S01E10.avi
Malcolm-in-the-Middle-E10.mp4
Malcolm.in.the.Middle.S02E03.mkv
TheOffice_E05.avi # No Season Specified, Defaults to Season One

All of the following are supported:

  • Spaces, dots, underscores, dashes
  • Optional season (defaults to season 1 if not found)

FAQ

Will this overwrite existing files?

No. The script does not overwrite files. It renames only when the target filename does not exist. You can use --dry-run to preview the result first.

Does it fetch subtitles or cover images?

No. This tool only renames the video files with accurate episode titles.

Contributions

Pull requests, suggestions, and issues are welcome! Let's make it smarter and broader (e.g., subtitle renaming, fuzzy matching, show aliases, etc.).

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

shownamer-1.2.1.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shownamer-1.2.1-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file shownamer-1.2.1.tar.gz.

File metadata

  • Download URL: shownamer-1.2.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.5

File hashes

Hashes for shownamer-1.2.1.tar.gz
Algorithm Hash digest
SHA256 c868851d25ee80089257d44e4d81f17e5445d147e169f9688b67ad99775adad8
MD5 ed6e9c9f7175ffa7b1b90383c5f844b0
BLAKE2b-256 ba2aa985f68d241df4d2b4c27d2a95ece366ef64fdeef1cc01376faa0e188175

See more details on using hashes here.

File details

Details for the file shownamer-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: shownamer-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.5

File hashes

Hashes for shownamer-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b1103e9c8056ca9fb291c7d59e7e6762afec6456c51d795e9c171617fa1428f
MD5 856442512d5b20a4f6e7bda3b072200b
BLAKE2b-256 a16c3051f9463669dad5975b617466a091baf10ccfbce14d847d389a1d7a0305

See more details on using hashes here.

Supported by

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