Rename anime files like what Sonarr does

[hillz2]

Hi, I use anipy-cli only to download anime episodes then watch them on Jellyfin, the problem is that I have to use Sonarr to rename the downloaded episodes so that they can be synced properly with Jellyfin. This is an example of how episodes should be renamed:

root@at-home:/mnt/sda1/media/Anime #  tree Make\ Heroine\ ga\ Oosugiru\!                  
Make Heroine ga Oosugiru!
└── Season 1
    ├── Makeine - Too Many Losing Heroines! - S01E01 - Professional Childhood Friend Yanami Anna's Style of Losing HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E02 - The Promised Failure for You HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E03 - Losing the Battle Before It Is Ever Fought HDTV-1080p.en.vtt
    ├── Makeine - Too Many Losing Heroines! - S01E03 - Losing the Battle Before It Is Ever Fought HDTV-1080p.ts
    ├── Makeine - Too Many Losing Heroines! - S01E04 - When You Stare Into a Losing Heroine, the Losing Heroine Stares Back Into You HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E05 - Asagumo Chihaya Is Led Astray HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E06 - Let Any One of You Who Has Never Been Dumped Be the First to Throw a Stone at the Losing Heroine HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E07 - The Other Side of a Happy Ending HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E08 - If You Are in Trouble, Feel Free to Consult HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E09 - Consider Your Teacher a Stain on the Ceiling or Something, and Please Continue HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E10 - I Suppose It's a Bit Too Early for Goodbye HDTV-1080p.mp4
    ├── Makeine - Too Many Losing Heroines! - S01E11 - Let's Have a Talk About Responsibility HDTV-1080p.mp4
    └── Makeine - Too Many Losing Heroines! - S01E12 - Am I Actually Just Some Unseasoned Rando Who Drops In for the Last Episode With the Losing Heroine HDTV-1080p.mp4

2 directories, 13 files

For each anime title there's Season 1 folder or Season 2 etc. then the actual episodes are placed in those seasons. The format is like this:

{Series Title} - S{season:00}E{episode:00} - {Episode Title} {Quality Full}

On jellyfin the anime would look like this with info and everything

Do you think anipy-cli can implement such feature ?

[sdaqo]

Hmm, yeah the main problem is the season, I don't recall any season metadata from allanime, but will see, maybe the prequel and sequels are listed.

Generally the custom file name is already a thing.

I do feel like it makes sense to have a separate Programm for this but I will look into it.

[hillz2]

If there's no season metadata from allanime then just create Season 1 or Season 0 it doesn't really matter

[hillz2]

I just found out that your script can run external scripts

def post_download_scripts(self) -> Dict[str, List[str]]:
        """With this option you can define scripts that run after a file
        has been downloaded. As with the 'providers' option, you can configure
        different behaviour, depending on which part of anipy-cli the download occurs.
        Configurable areas are as follows: default (and history), download (-D), seasonal (-S),
        anilist (-A) and mal (-M). The example will show you how it is done! Please note that
        if you define several scripts for one area, they will run in the order you put them in the list.
        You can also define a timeout (in seconds), after which a script will be terminated,
        if set to null there will be no timeout and any script will run forever.

        A "script" is a path to an executable file which accepts following parameters (in this order):
            1. Path to the file
            2. Name of series
            3. Episode
            4. Provider
            5. Quality
            6. Language profile

        Examples:
            post_download_scripts:
                default: [] # used in default mode and for the history
                download: ["/scripts/send_notification.sh", "/scripts/move_and_rename.sh"]
                seasonal: ["link_to_jellyfin.bat", "jellyfin_library_update.exe"] # All executable files should work, including windows specific
                mal: ["hard_link_to_shoko"]
                timeout: 60 # terminate any script after running for 60 seconds
        """
        defaults = {
            "default": [],
            "download": [],
            "seasonal": [],
            "mal": [],
            "anilist": [],
            "timeout": None,
        }

Let's say I have Jigokuraku anime already downloaded on my hard drive, the structure looks like this:

root@at-home:/mnt/sda1/media/Anime #  tree Jigokuraku
Jigokuraku
└── Season 1
    ├── Jigokuraku_01.en.vtt
    ├── Jigokuraku_01.mp4
    ├── Jigokuraku_02.mp4
    ├── etc...

and I have Jigokuraku Season 2 on my MAL watchlist, after anipy-cli is finished downloading a new episode, I want to run an external script to move the downloaded episode to Jigokuraku -> Season 2 folder like this:

root@at-home:/mnt/sda1/media/Anime #  tree Jigokuraku
Jigokuraku
└── Season 2
    ├── New downloaded episode.en.vtt

What should the external script look like ? Can anipy-cli pass a parameter like the folder name and episode name to an external script ?

[sdaqo]

Yes, as you can see in the docstring, you can use the variables which are passed to the script, $1 through $6

[sdaqo]

There is an example in #215

[hillz2]

Thanks, I'll look into it

[hillz2]

With the help of AI, i was able to create a script to organize anime to support Jellyfin named organize_anime.py:

#!/usr/bin/env python3
import sys
import os
import re
import shutil
import requests
import argparse
from datetime import datetime

# ==========================================
# CONFIGURATION
# ==========================================
MEDIA_ROOT = os.path.expanduser("~/Videos/Anime")
LOG_FILE = "/tmp/anipy_move.log"

# ==========================================
# ARGUMENT PARSING
# ==========================================
args = sys.argv[1:]
DRY_RUN = "--test" in args or "--dry-run" in args
DEBUG = "--debug" in args or DRY_RUN

positional_args = [arg for arg in args if not arg.startswith("--")]

if len(positional_args) < 3:
    print("Usage: organize_anime.py [FILE_PATH] [SERIES_NAME] [EPISODE_NUM] [OPTS...]")
    sys.exit(1)

VIDEO_PATH = positional_args[0]
RAW_SERIES_NAME = positional_args[1]
EPISODE_NUM = positional_args[2]

# ==========================================
# HELPER FUNCTIONS
# ==========================================
def log(message, level="INFO"):
    timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
    formatted_msg = f"[{timestamp}] [{level}] {message}"
    print(formatted_msg)
    if not DRY_RUN: # Only write to log file if not testing (or change as needed)
        try:
            with open(LOG_FILE, "a") as f:
                f.write(formatted_msg + "\n")
        except: pass

def clean_filename(name):
    # Remove illegal characters
    return re.sub(r'[\\/*?:"<>|]', "", name).strip()

# ==========================================
# CORE LOGIC: PREQUEL TRACING (SONARR STYLE)
# ==========================================
def get_anime_info_with_relations(search_query):
    log(f"Querying AniList for: '{search_query}'", "DEBUG")
    
    # We request the Media AND its relations (Prequels)
    query = '''
    query ($search: String) {
      Media (search: $search, type: ANIME) {
        id
        title {
          romaji
          english
          userPreferred
        }
        format
        relations {
          edges {
            relationType
            node {
              id
              title {
                romaji
                english
                userPreferred
              }
              format
              type
            }
          }
        }
      }
    }
    '''
    
    # If we are looking up by ID (recursive step), usage is different, 
    # but for simplicity we will just do a fresh query by ID if needed, 
    # or rely on the edges provided in the first call if usually sufficient.
    # Actually, traversing deep chains requires recursive ID queries.
    
    variables = {'search': search_query}
    url = 'https://graphql.anilist.co'

    try:
        response = requests.post(url, json={'query': query, 'variables': variables}, timeout=5)
        if response.status_code != 200:
            return None
        
        data = response.json()
        if not data.get('data') or not data['data'].get('Media'):
            return None
            
        return data['data']['Media']
    except Exception as e:
        log(f"API Error: {e}", "ERROR")
        return None

def get_parent_by_id(media_id):
    """Recursively fetch parent to find the root."""
    query = '''
    query ($id: Int) {
      Media (id: $id) {
        id
        title { english romaji }
        format
        relations {
          edges {
            relationType
            node { id title { english romaji } format type }
          }
        }
      }
    }
    '''
    try:
        response = requests.post('https://graphql.anilist.co', json={'query': query, 'variables': {'id': media_id}})
        if response.status_code == 200:
            return response.json()['data']['Media']
    except: pass
    return None

def resolve_series_structure(raw_name):
    """
    Returns: (Root_Series_Name, Calculated_Season_Number)
    """
    media = get_anime_info_with_relations(raw_name)
    if not media:
        return None, 1

    # 1. Start with the found anime
    current_season = 1
    
    # Get the best title for the *current* node (to check regex)
    curr_title = media['title']['english'] or media['title']['romaji']
    
    # CHECK 1: Explicit Regex (Fastest). If title says "Season 2", trust it.
    match = re.search(r'(?i)(?:Season|S)\s*(\d+)', raw_name) # Check raw input first
    if match: return clean_title_regex(curr_title), int(match.group(1))
    
    match = re.search(r'(?i)(?:Season|S)\s*(\d+)', curr_title) # Check official title
    if match: return clean_title_regex(curr_title), int(match.group(1))

    # CHECK 2: Prequel Chain (The "Konosuba 2" Fix)
    # We act like a linked list crawler.
    # We traverse up until we hit a node with NO TV Prequel.
    
    root_title = curr_title # Default to current
    pointer = media
    
    while True:
        # Find a PREQUEL relation that is a TV Series
        prequel_node = None
        if 'relations' in pointer and pointer['relations']:
            for edge in pointer['relations']['edges']:
                # STRICT RULE: Must be PREQUEL and must be TV (ignore OVAs/Movies for season counting usually)
                if edge['relationType'] == 'PREQUEL' and edge['node']['format'] == 'TV' and edge['node']['type'] == 'ANIME':
                    prequel_node = edge['node']
                    break
        
        if prequel_node:
            log(f"Found Prequel: {prequel_node['title']['english'] or prequel_node['title']['romaji']}", "DEBUG")
            current_season += 1
            
            # The "Root Title" should be the oldest ancestor we find
            p_title = prequel_node['title']['english'] or prequel_node['title']['romaji']
            root_title = clean_title_regex(p_title)
            
            # Fetch full info for the prequel to continue the chain
            # (The edge data is partial, we need its relations too)
            pointer = get_parent_by_id(prequel_node['id'])
            if not pointer: break # API fail, stop here
        else:
            # No more prequels, we are at the root
            break
            
    return root_title, current_season

def clean_title_regex(title):
    # Removes "Season X", "2", "2nd Season" from the end of a Name to make it a Root Name
    # e.g. "Konosuba 2" -> "Konosuba"
    # e.g. "Attack on Titan Season 2" -> "Attack on Titan"
    
    # Remove "Season X"
    t = re.sub(r'(?i)\s*(?:Season|S)\s*\d+', '', title)
    # Remove "2nd Season", "3rd Season"
    t = re.sub(r'(?i)\s*\d+(?:st|nd|rd|th)\s*Season', '', t)
    # Remove "II", "III", "IV" at end
    t = re.sub(r'\s+(?:II|III|IV|V)$', '', t)
    # Remove simple number at end "Konosuba 2" -> "Konosuba", but be careful of "Mob Psycho 100"
    # Logic: If number is < 10, likely a season number.
    match = re.search(r'\s+(\d+)$', t)
    if match:
        if int(match.group(1)) < 10: 
            t = re.sub(r'\s+\d+$', '', t)
            
    return t.strip()

# ==========================================
# MAIN EXECUTION
# ==========================================
log("========================================")
log(f"PROCESSING: {RAW_SERIES_NAME}")

# 1. Resolve Metadata
final_series_name, detected_season = resolve_series_structure(RAW_SERIES_NAME)

if not final_series_name:
    log("API failed. Using local fallback.", "WARN")
    final_series_name = RAW_SERIES_NAME
    detected_season = 1

# 2. Setup Paths
safe_series_name = clean_filename(final_series_name)
padded_season = f"{detected_season:02d}"
padded_episode = f"{int(EPISODE_NUM):02d}"

season_dir = f"Season {detected_season}"
target_dir = os.path.join(MEDIA_ROOT, safe_series_name, season_dir)

# Construct Filename: "Series Name - S01E01.mkv"
if os.path.exists(VIDEO_PATH):
    ext = os.path.splitext(VIDEO_PATH)[1]
else:
    ext = ".mkv"
    
new_filename = f"{safe_series_name} - S{padded_season}E{padded_episode}{ext}"
target_path = os.path.join(target_dir, new_filename)

# 3. Report / Execute
if DRY_RUN:
    print("\n--- SONARR-STYLE DRY RUN ---")
    print(f"Input Name   : {RAW_SERIES_NAME}")
    print(f"Logic Used   : Prequel Chain Analysis (AniList)")
    print(f"Root Series  : {safe_series_name}")
    print(f"Season Num   : {detected_season}")
    print(f"Target Dir   : {target_dir}")
    print(f"Target File  : {new_filename}")
    print("----------------------------")
    print("RESULT: SUCCESS (Simulation)")
else:
    # Create Dir
    if not os.path.exists(target_dir):
        os.makedirs(target_dir, exist_ok=True)
        log(f"Created Dir: {target_dir}")
    
    # Move File
    if os.path.exists(VIDEO_PATH):
        shutil.move(VIDEO_PATH, target_path)
        log(f"Moved file to: {target_path}")
    else:
        log("Source file missing.", "ERROR")
        sys.exit(1)