Skip to main content

Download japanese anime subtitles from Jimaku

Project description

Jimaku-DL

AUR License GitHub Release AUR Last Modified codecov

A tool for downloading Japanese subtitles for anime from Jimaku

Jimaku-DL Demo

Features

  • Download subtitles from Jimaku.cc
  • Automatic subtitle synchronization with video (requires ffsubsync)
  • Playback with MPV player and Japanese audio track selection
  • On-screen notification when subtitle synchronization is complete
  • Background synchronization during playback
  • Cross-platform support (Windows, macOS, Linux)
  • Smart filename and directory parsing for anime detection
  • Cache AniList IDs for faster repeat usage
  • Interactive subtitle selection with fzf
  • Automatic subtitle renaming to match video filenames

Installation

pip install jimaku-dl

Arch Linux

Arch Linux users can install python-jimaku-dl from the AUR

paru -S python-jimaku-dl
# or
yay -S python-jimaku-dl

Requirements

  • Python 3.8+
  • fzf for interactive selection menus (required)
  • MPV for video playback (optional)
  • ffsubsync for subtitle synchronization (optional)

Usage

# Basic usage - Download subtitles for a video file
jimaku-dl /path/to/your/anime.mkv

# Download subtitles and play video immediately
jimaku-dl /path/to/your/anime.mkv --play

# Download, play, and synchronize subtitles in background
jimaku-dl /path/to/your/anime.mkv --play --sync

# Download subtitles and rename to match video filename
jimaku-dl /path/to/your/anime.mkv --rename

# Download subtitles for all episodes in a directory
jimaku-dl /path/to/your/anime/season-1/

# Specify custom destination directory
jimaku-dl /path/to/your/anime.mkv --dest-dir /path/to/subtitles

API Token

You'll need a Jimaku API token to use this tool. Set it using one of these methods:

  1. Command line option:

    jimaku-dl /path/to/anime.mkv --token YOUR_TOKEN_HERE
    
  2. Environment variable:

    export JIMAKU_API_TOKEN="your-token-here"
    jimaku-dl /path/to/anime.mkv
    

Command-Line Options

usage: jimaku-dl [options] MEDIA_PATH

positional arguments:
  MEDIA_PATH            Path to media file or directory

options:
  -h, --help            Show this help message and exit
  -v, --version         Show program version number and exit
  -t TOKEN, --token TOKEN
                        Jimaku API token (can also use JIMAKU_API_TOKEN env var)
  -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        Set logging level
  -d DEST_DIR, --dest-dir DEST_DIR
                        Destination directory for subtitles
  -p, --play           Play media with MPV after download
  -a ANILIST_ID, --anilist-id ANILIST_ID
                        AniList ID (skip search)
  -s, --sync           Sync subtitles with video in background when playing

File Naming

Jimaku Downloader supports various file naming conventions to extract show title, season, and episode information. It is recommended to follow the Trash Guides recommended naming schema for best results.

Examples

  • Show Title - S01E02 - Episode Name [1080p].mkv
  • Show.Name.S01E02.1080p.mkv
  • Show_Name_S01E02_HEVC.mkv
  • /path/to/Show Name/Season-1/Show Name - 02 [1080p].mkv

Development

To contribute to Jimaku Downloader, follow these steps:

  1. Clone the repository:

    git clone https://github.com/yourusername/jimaku-dl.git
    cd jimaku-dl
    
  2. Create a virtual environment and activate it:

    python -m venv venv
    source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
    
  3. Install the dependencies:

    pip install -r requirements.txt
    pip install -r requirements_dev.txt
    

License

Jimaku Downloader is licensed under the GPLv3 License. See the LICENSE file for more information.

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

jimaku_dl-0.1.6.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

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

jimaku_dl-0.1.6-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

Details for the file jimaku_dl-0.1.6.tar.gz.

File metadata

  • Download URL: jimaku_dl-0.1.6.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jimaku_dl-0.1.6.tar.gz
Algorithm Hash digest
SHA256 bbde179ab3c176d8251f6f475abf0312b11653a7a767918825d1c8589d22723d
MD5 44b5e5edd8aacaae2bc81f10f0424ee1
BLAKE2b-256 4d07d20738462353515f21536ab322ed54b1c41142dfa7ddde6069c8e2425551

See more details on using hashes here.

File details

Details for the file jimaku_dl-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: jimaku_dl-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 34.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jimaku_dl-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3a220c140228a7fc0efc901febf2340412ba029a09d2596142629b6f71c080df
MD5 18e4f30a75d03243b7d3bee384b01c0b
BLAKE2b-256 83769ac7b74dce8e92e7acbd3718378b7e9e637982897b50e6ca0f3e9b67e44f

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