Kemono Downloader

https://github.com/yuvi9587/kemono-downloader
Admin
A powerful, feature-rich GUI application for downloading content from Kemono.su and Coomer.party,...
Tokens:3,381
Snippets:21
Trust Score:5.8
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Kemono Downloader Application

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/readme.md

Execute this command in the application's root directory to start the Kemono Downloader. Ensure all dependencies are installed before running.

```bash
python main.py
```

--------------------------------

### Install Python Dependencies for Kemono Downloader

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/readme.md

This command installs the necessary Python packages required to run the Kemono Downloader application. It includes PyQt5 for the GUI, requests for HTTP operations, Pillow for image processing, and mega.py for MEGA integration.

```bash
pip install PyQt5 requests Pillow mega.py
```

--------------------------------

### Kemono Downloader: Page Range Input Fields

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Input fields to define a specific range of pages to process for creator URLs, useful for partial downloads.

```APIDOC
UI_Element: Page Range Input Fields (Start to End)
  Purpose: Specify a range of pages to fetch and process for creator URLs.
  Usage:
    - First field: Starting page number.
    - Second field: Ending page number.
  Behavior:
    - If left blank: Typically processes all pages or up to a reasonable limit.
    - Disabled: For single post URLs or when "Manga/Comic Mode" is active (as manga mode fetches all posts for chronological sorting).
```

--------------------------------

### Kemono Downloader: Download Location Input Field

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Field and button to specify the root directory for all downloaded content, ensuring files are saved to the desired location.

```APIDOC
UI_Element: Download Location Input Field
  Purpose: Specify the main directory for saving all downloaded files and folders.
  Usage:
    - Type or paste path directly.
    - "Browse..." Button: Opens system dialog to select a folder.
  Requirement:
    - Must be filled unless "Only Links" filter mode is active.
```

--------------------------------

### Kemono Downloader: Creator Selection Button and Dialog

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Button to open a dialog for managing and selecting multiple creators, allowing batch addition to the URL field or direct queuing of posts.

```APIDOC
UI_Element: Creator Selection Button
  Icon: 🎨 (Artist Palette)
  Location: Next to the URL input field
  Purpose: Opens the "Creator Selection" dialog.

Dialog: Creator Selection
  Features:
    - Loads creators from 'creators.json' file.
    - Search Bar: Filters creator list by name.
    - Creator List: Displays creators with service (e.g., Patreon, Fanbox) and ID.
    - Selection: Checkboxes for multi-creator selection.
    - "Add Selected to URL" Button: Adds comma-separated selected creator names to main URL input.
    - "Fetch Posts" Button: Retrieves latest posts for selected creators, opening 'Fetched Posts View'.
    - "Download Scope" Radio Buttons:
      - Characters: Organizes folders by character names (assumes creator names are character names).
      - Creators: Organizes folders by actual creator names.

Dialog_Pane: Fetched Posts View (appears after "Fetch Posts" button click)
  Features:
    - Posts Area Title Label: Shows loading status or count of fetched posts.
    - Posts Search Input: Filters fetched posts by title.
    - Posts List Widget: Displays checkable posts, often grouped by creator.
    - Select All / Deselect All Buttons: For convenience in post selection.
    - "Add Selected Posts to Queue" Button: Adds checked posts directly to main download queue. Updates main URL field with "{count} items in queue from popup".
    - "Close" Button: Hides this view, returns to creator selection list.
```

--------------------------------

### API: Skip with Words Input Field

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Explains the 'Skip with Words' input field, used to exclude posts or files that contain specified keywords. Keywords should be comma-separated.

```APIDOC
Skip with Words Input Field:
  Purpose: Exclude posts or files containing specified keywords.
  Usage: Enter words or phrases, comma-separated (e.g., WIP, sketch, preview).
```

--------------------------------

### Filename Style Toggle Button (Manga Mode)

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Controls how files are named when downloading in a manga/comic-like fashion. Cycles through various options on click, affecting file prefixes and numbering.

```APIDOC
Control: Filename Style Toggle Button
Purpose: Controls how files are named in manga/comic mode.
Options:
  - Name: Post Title (Default for non-manga): First file in a post named after post title; subsequent files in same post keep original names.
  - Name: Original File: All downloaded files attempt to keep original filenames. Optional 'Filename Prefix' appears.
  - Name: Title+G.Num (Global Numbering): All files across all downloaded posts get a prefix from their post's title, followed by a global sequential number (e.g., 'Chapter 1_001.jpg'). Disables post-level multithreading.
  - Name: Date Based: Files named sequentially (e.g., '001.jpg') based on post's publication date. Optional 'Filename Prefix' appears. Disables post-level multithreading.
```

--------------------------------

### API: Character Filter Scope Button

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Describes the 'Filter: [Type]' button, which controls how the character filter is applied. It cycles through options to define the scope of the character matching.

```APIDOC
Filter: [Type] Button (Scope for Character Filter):
  Location: Next to the "Filter by Character(s)" input.
  Purpose: Defines how the character filter is applied. Cycles through options on click.
  Options:
    - Filter: Files: Checks individual filenames against the character filter. Only matching files from a post are downloaded.
    - Filter: Title (Default): Checks post titles against the character filter. If the title matches, all files from that post are downloaded.
    - Filter: Both: Checks the post title first. If no match, then checks individual filenames within that post.
    - Filter: Comments (Beta): Checks filenames first. If no file match, then checks post comments/description. (Note: May use more API requests).
```

--------------------------------

### Download Thumbnails Only Checkbox

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Controls whether only small preview images (thumbnails) are downloaded. If 'Scan Content for Images' is also active, only images found by content scan are downloaded as thumbnails, ignoring API thumbnails.

```APIDOC
Option: Download Thumbnails Only
Purpose: Download only small preview images (thumbnails) provided by the API.
Behavior (with 'Scan Content for Images' active): Only images found by content scan (embedded <img> tags) are downloaded as thumbnails; API thumbnails are ignored.
```

--------------------------------

### Kemono Downloader: URL Input Field

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

The primary input field for specifying content to download, supporting various Kemono and Coomer URLs for creators and individual posts. Its behavior changes based on active modes.

```APIDOC
UI_Element: URL Input Field
  Purpose: Input field for Kemono/Coomer creator or post URLs.
  Usage:
    - Supports full URLs for Kemono.su/Coomer.party creator pages (e.g., https://kemono.su/patreon/user/12345)
    - Supports full URLs for Kemono.su/Coomer.party individual posts (e.g., https://kemono.su/patreon/user/12345/post/98765)
    - Accepts mirrors like kemono.party, coomer.su
  Notes:
    - Disabled when "Favorite Mode" is active, displaying "Favorite Mode active" message.
    - Can display "{count} items in queue from popup" if populated from 'Creator Selection' dialog.
```

--------------------------------

### API: Skip Words Scope Button

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Details the 'Scope: [Type]' button, which determines how the 'Skip with Words' filter is applied. It cycles through options to define the scope of keyword skipping.

```APIDOC
Scope: [Type] Button (Scope for Skip with Words):
  Location: Next to the "Skip with Words" input.
  Purpose: Defines how the skip words are applied. Cycles through options on click.
  Options:
    - Scope: Files: Skips individual files if their names contain any of the skip words.
    - Scope: Posts (Default): Skips entire posts if their titles contain any of the skip words.
    - Scope: Both: Checks the post title first. If no skip words match, then checks individual filenames.
```

--------------------------------

### Compress to WebP Checkbox

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Converts downloaded images to WebP format to potentially save disk space. Requires the `Pillow` library. Attempts to convert images larger than 1.5MB if the WebP version is significantly smaller, without keeping original files.

```APIDOC
Option: Compress to WebP
Purpose: Convert downloaded images to WebP format.
Requirement: Pillow library must be installed.
Behavior: Converts images > 1.5MB if WebP is significantly smaller. Original files are not kept.
```

--------------------------------

### Optional Filename Prefix Input Field (Manga Mode)

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Allows adding a custom prefix to all filenames generated using the 'Name: Original File' or 'Name: Date Based' filename styles in Manga Mode.

```APIDOC
Option: Optional Filename Prefix Input Field
Visibility: Appears when 'Filename Style' is set to 'Name: Original File' or 'Name: Date Based'.
Purpose: Add a custom prefix to all filenames generated using these styles (e.g., 'MySeries_001.jpg').
```

--------------------------------

### API: Skip Archive Type Checkboxes

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Details the 'Skip .zip' and 'Skip .rar' checkboxes, allowing users to individually prevent the download of these archive file types. Their behavior is dependent on other filter settings.

```APIDOC
Skip .zip / Skip .rar Checkboxes:
  Purpose: Individually choose to skip downloading .zip files or .rar files.
  Behavior: Disabled if the "📦 Only Archives" filter is active.
```

--------------------------------

### Scan Content for Images Checkbox

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Enables scanning HTML content of posts for `<img>` tags and direct image links to download embedded images not listed as direct attachments in the API response. Resolves relative image paths to absolute URLs.

```APIDOC
Option: Scan Content for Images
Purpose: Actively scan HTML content for <img> tags and direct image links.
Behavior: Crucial for downloading images embedded in post descriptions. Resolves relative image paths to absolute URLs.
```

--------------------------------

### API: File Type Filter Radio Buttons

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Explains the 'Filter Files' radio buttons, which allow users to select specific types of files to download. This controls the file formats included in the download.

```APIDOC
Filter Files (Radio Buttons):
  Purpose: Select the types of files to download.
  Options:
    - All: Download all file types attached to posts.
    - Images/GIFs: Download only common image formats (JPG, PNG, GIF, WebP, etc.).
    - Videos: Download only common video formats (MP4, MOV, MKV, WebM, etc.).
    - 📦 Only Archives: Exclusively download .zip and .rar files.
      Behavior: Disables "Skip .zip/.rar" checkboxes and "Show External Links in Log" feature.
    - 🎧 Only Audio: Download only common audio formats (MP3, WAV, FLAC, OGG, etc.).
    - 🔗 Only Links: Do not download any files. Instead, extract and display external links found in post descriptions in the log area.
      Behavior: Main action button changes to "🔗 Extract Links".
```

--------------------------------

### API: Remove Words from Name Input Field

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Describes the 'Remove Words from name' input field, used to clean up downloaded filenames by removing specified unwanted words or phrases. Words should be comma-separated.

```APIDOC
Remove Words from name Input Field:
  Purpose: Clean up downloaded filenames by removing specified unwanted words or phrases.
  Usage: Enter words or phrases, comma-separated (e.g., patreon, [HD], kemono).
```

--------------------------------

### Custom Folder Name Input Field (Single Post)

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Allows specifying a custom name for the folder where a single post's contents will be saved. This field is only visible when a single post URL is entered and the 'Separate Folders by Name/Title' option is enabled.

```APIDOC
Option: Custom Folder Name (Single Post Only)
Purpose: Specify a custom folder name for a single post's content.
Visibility: Appears only if:
  1. A single post URL is entered.
  2. 'Separate Folders by Name/Title' option is enabled.
```

--------------------------------

### Manga/Comic Mode Overview

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Specialized mode for downloading creator feeds in a way suitable for sequential reading. Primarily activated by downloading a creator's feed and selecting a relevant 'Filename Style'. Processes posts chronologically (oldest to newest), typically disabling the 'Page Range' input.

```APIDOC
Mode: Manga/Comic Mode
Activation: Primarily by downloading a creator's feed (not single post) and selecting a relevant 'Filename Style'.
Core Behavior: Processes and downloads posts from the creator's feed in chronological order (oldest to newest). 'Page Range' input is typically disabled.
```

--------------------------------

### API: Filter by Character(s) Input Field

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/features.md

Defines how to use the character filtering input field, including basic and advanced syntax for single, grouped, and aliased characters. This field controls which content is downloaded based on character names.

```APIDOC
Filter by Character(s) Input Field:
  Purpose: Download content related to specific characters.
  Usage: Enter character names, comma-separated.
  Advanced Syntax:
    - Nami: Simple character filter. Matches "Nami".
    - (Vivi, Ulti, Uta): Grouped characters. Matches "Vivi" OR "Ulti" OR "Uta".
      Behavior: If "Separate Folders" is on, creates a shared folder (e.g., "Vivi Ulti Uta").
      Known.txt: Adds "Vivi", "Ulti", "Uta" as separate entries if new.
    - (Boa, Hancock)~: Aliased characters. Matches "Boa" OR "Hancock" but treats them as the same entity.
      Behavior: If "Separate Folders" is on, creates a shared folder (e.g., "Boa Hancock").
      Known.txt: Adds "Boa Hancock" as a single group entry if new, with "Boa" and "Hancock" as aliases.
```

--------------------------------

### Upgrade Python Libraries to Resolve Asyncio AttributeError

Source: https://github.com/yuvi9587/kemono-downloader/blob/main/readme.md

These commands upgrade the 'tenacity' and 'mega.py' libraries, which can resolve 'AttributeError: module 'asyncio' has no attribute 'coroutine'' issues, especially with Python 3.10+.

```bash
pip install --upgrade tenacity
pip install --upgrade mega.py
```
Tokens:
Raw