Kemono-Downloader/readme.md

155 lines
6.6 KiB
Markdown
Raw Normal View History

2025-06-09 08:35:42 +01:00
<h1 align="center">Kemono Downloader v5.1.0</h1>
2025-05-21 17:20:16 +05:30
2025-05-29 19:07:28 +05:30
<table align="center">
<tr>
<td align="center">
<img src="Read/Read.png" alt="Post Downloader Tab" width="400"/>
<br>
<strong>Default</strong>
</td>
<td align="center">
<img src="Read/Read1.png" alt="Creator Downloader Tab" width="400"/>
<br>
<strong>Favorite mode</strong>
</td>
</tr>
<tr>
<td align="center">
<img src="Read/Read2.png" alt="Settings Tab" width="400"/>
<br>
2025-05-29 19:09:08 +05:30
<strong>Single Post</strong>
2025-05-29 19:07:28 +05:30
</td>
<td align="center">
<img src="Read/Read3.png" alt="Settings Tab" width="400"/>
<br>
2025-05-29 19:09:08 +05:30
<strong>Manga/Comic Mode</strong>
2025-05-29 19:07:28 +05:30
</td>
<td align="center">
</td>
</tr>
</table>
2025-05-21 17:20:16 +05:30
---
2025-05-08 20:24:22 +05:30
2025-05-30 21:04:02 +05:30
A powerful, feature-rich GUI application for downloading content from **[Kemono.su](https://kemono.su)** (and its mirrors like kemono.party) and **[Coomer.party](https://coomer.party)** (and its mirrors like coomer.su).
Built with PyQt5, this tool is designed for users who want deep filtering capabilities, customizable folder structures, efficient downloads, and intelligent automation, all within a modern and user-friendly graphical interface.
2025-05-15 08:45:32 +05:30
2025-05-30 21:04:02 +05:30
*This v5.0.0 release marks a significant feature milestone. Future updates are expected to be less frequent, focusing on maintenance and minor refinements.*
2025-06-09 08:35:42 +01:00
*Update v5.1.0 enhances error handling and UI responsiveness.*
2025-06-02 04:06:07 +01:00
<p align="center">
<a href="features.md"><strong>📚 Full Feature List</strong></a>
<a href="LICENSE"><strong>📝 License</strong></a>
</p>
2025-05-18 16:12:19 +05:30
---
2025-06-02 03:55:54 +01:00
## Feature Overview
Kemono Downloader offers a range of features to streamline your content downloading experience:
- **User-Friendly Interface:** A modern PyQt5 GUI for easy navigation and operation.
- **Flexible Downloading:**
- Download content from Kemono.su (and mirrors) and Coomer.party (and mirrors).
- Supports creator pages (with page range selection) and individual post URLs.
- Standard download controls: Start, Pause, Resume, and Cancel.
- **Powerful Filtering:**
- **Character Filtering:** Filter content by character names. Supports simple comma-separated names and grouped names for shared folders.
- **Keyword Skipping:** Skip posts or files based on specified keywords.
- **Filename Cleaning:** Remove unwanted words or phrases from downloaded filenames.
- **File Type Selection:** Choose to download all files, or limit to images/GIFs, videos, audio, or archives. Can also extract external links only.
- **Customizable Downloads:**
- **Thumbnails Only:** Option to download only small preview images.
- **Content Scanning:** Scan post HTML for `<img>` tags and direct image links, useful for images embedded in descriptions.
- **WebP Conversion:** Convert images to WebP format for smaller file sizes (requires Pillow library).
- **Organized Output:**
- **Automatic Subfolders:** Create subfolders based on character names (from filters or `Known.txt`) or post titles.
- **Per-Post Subfolders:** Option to create an additional subfolder for each individual post.
- **Manga/Comic Mode:**
- Downloads posts from a creator's feed in chronological order (oldest to newest).
- Offers various filename styling options for sequential reading (e.g., post title, original name, global numbering).
- **⭐ Favorite Mode:**
- Directly download from your favorited artists and posts on Kemono.su.
- Requires a valid cookie and adapts the UI for easy selection from your favorites.
- Supports downloading into a single location or artist-specific subfolders.
- **Performance & Advanced Options:**
- **Cookie Support:** Use cookies (paste string or load from `cookies.txt`) to access restricted content.
- **Multithreading:** Configure the number of simultaneous downloads/post processing threads for improved speed.
- **Logging:**
- A detailed progress log displays download activity, errors, and summaries.
2025-05-16 16:08:48 +05:30
---
2025-05-15 08:45:32 +05:30
2025-06-09 08:35:42 +01:00
## ✨ What's New in v5.1.0
- **Enhanced Error File Management**: The "Error" button now opens a dialog listing files that failed to download. This dialog includes:
- An option to **retry selected** failed downloads.
- A new **"Export URLs to .txt"** button, allowing users to save links of failed downloads either as "URL only" or "URL with details" (including post title, ID, and original filename).
- Fixed a bug where files skipped during retry (due to existing hash match) were not correctly removed from the error list.
- **Improved UI Stability**: Addressed issues with UI state management to more accurately reflect ongoing download activities (including retries and external link downloads). This prevents the "Cancel" button from becoming inactive prematurely while operations are still running.
---
2025-05-23 17:22:54 +05:30
## Installation
2025-05-15 08:45:32 +05:30
2025-05-16 16:08:48 +05:30
### Requirements
2025-05-30 21:04:02 +05:30
- Python 3.6 or higher
- pip (Python package installer)
2025-05-18 16:12:19 +05:30
2025-05-16 16:08:48 +05:30
### Install Dependencies
2025-05-30 21:04:02 +05:30
Open your terminal or command prompt and run:
2025-05-30 21:08:23 +05:30
```bash
2025-06-07 17:17:28 +05:30
pip install PyQt5 requests Pillow mega.py
2025-05-30 21:09:15 +05:30
```
2025-06-02 03:55:54 +01:00
### Running the Application
Navigate to the application's directory in your terminal and run:
2025-05-16 12:50:32 +05:30
```bash
2025-05-30 21:08:23 +05:30
python main.py
2025-05-30 21:09:15 +05:30
```
2025-05-30 21:08:23 +05:30
2025-06-02 03:55:54 +01:00
### Optional Setup
- **Main Inputs:**
2025-05-30 21:08:23 +05:30
- Place your `cookies.txt` in the root directory (if using cookies).
- Prepare your `Known.txt` and `creators.json` in the same directory for advanced filtering and selection features.
---
2025-06-07 17:17:28 +05:30
## Troubleshooting
### AttributeError: module 'asyncio' has no attribute 'coroutine'
If you encounter an error message similar to:
```
AttributeError: module 'asyncio' has no attribute 'coroutine'. Did you mean: 'coroutines'?
```
This usually means that a dependency, often `tenacity` (used by `mega.py`), is an older version that's incompatible with your Python version (typically Python 3.10+).
To fix this, activate your virtual environment and run the following commands to upgrade the libraries:
```bash
pip install --upgrade tenacity
pip install --upgrade mega.py
```
---
2025-05-30 21:08:23 +05:30
## Contribution
Feel free to fork this repo and submit pull requests for bug fixes, new features, or UI improvements!
---
## License
2025-06-07 16:38:23 +01:00
This project is under the Custom Licence
2025-06-01 12:52:44 +01:00
2025-06-01 12:53:36 +01:00
## Star History
2025-06-07 20:31:20 +05:30
<table align="center" style="border-collapse: collapse; border: none; margin-left: auto; margin-right: auto;">
<tr>
<td align="center" valign="middle" style="padding: 10px; border: none;">
<a href="https://www.star-history.com/#Yuvi9587/Kemono-Downloader&Date">
<img src="https://api.star-history.com/svg?repos=Yuvi9587/Kemono-Downloader&type=Date" alt="Star History Chart" width="650">
</a>
</table>
2025-06-02 04:00:39 +01:00
2025-06-07 16:38:23 +01:00
👉 See [features.md](features.md) for the full feature list.