The komga-cover-extractor from zachstultz

komga-cover-extractor's Introduction

Introduction
Installation
Usage
Examples
Future Goals
Contributing
License
Support and Contact

1. Introduction

Komga Cover Extractor is a Python automation script that automates the detection and extraction of covers from zip, cbz, and epub files, providing users with high-resolution local covers within Komga.

2. Installation

To use the Komga Cover Extractor, follow one of the options below:

Docker (Recommended)

You can use the Docker image available here, which simplifies the setup process.

Manual Installation

If you prefer manual installation, follow these steps:

Clone the repository: git clone https://github.com/zachstultz/komga-cover-extractor.git
Install required Python packages: pip3 install -r requirements.txt
(OPTIONAL) If you intend to use advanced RAR features, you may need to install unrar:
- Linux: sudo apt-get install unrar
- MacOS: brew install rar (requires brew) (untested)
- Windows: Install UnRAR.dll from rarlab.com (untested)

3. Usage

python3 komga_cover_extractor.py [-h] [-p [PATHS [PATHS ...]]] -wh WEBHOOK1,WEBHOOK2,upto N [-c COMPRESS] [-cq COMPRESS_QUALITY]

-p or --paths: The path/paths to be scanned for cover extraction.
-wh or --webhook: The optional Discord webhook URL for notifications about changes and errors.
-c or --compress: Whether or not to compress the extracted cover images.
-cq or --compress_quality: The quality of the compressed cover images.

4. Examples

With Compression:

python3 komga_cover_extractor.py -p "/path/to/manga" -p "/path/to/novels" -c "True" -cq "40"

Without Compression:

python3 komga_cover_extractor.py -p "/path/to/manga" -p "/path/to/novels"

5. Future Goals

1. Transforming the script into a comprehensive manga/light novel manager with a wide range of features (in-progress).
2. Modularizing volume/chapter keyword regexes across the script (in-progress).
3. Improving documentation to make the tool even more user-friendly (in-progress).

6. Contributing

We welcome contributions! If you'd like to contribute to the Komga Cover Extractor, please follow our Contribution Guidelines

7. License

This project is licensed under the [MIT License](LICENSE).

8. Support and Contact

If you need help or want to report issues, please [create an issue](https://github.com/zachstultz/komga-cover-extractor/issues) on GitHub.

komga-cover-extractor's People

Contributors

Stargazers

Watchers

komga-cover-extractor's Issues

yet another issue

            Similarity between: "yamada kun seven witches" and "yamada kun seven witches" Score: 1.0 out of 1.0

    Required Folder Matching Percent: 90%
            Download Folder CBZ Percent: 100.0%
            Existing Folder CBZ Percent: 100.0%

            Download Folder EPUB Percent: 0%
            Existing Folder EPUB Percent: 0%

            Download Folder Chapter Percent: 0%
            Existing Folder Chapter Percent: 0%

            Download Folder Volume Percent: 100.0%
            Existing Folder Volume Percent: 100.0%

            Found existing series from cache: /home/ubuntu/manga/Yamada-kun and the Seven Witches

Traceback (most recent call last):
File "/home/ubuntu/komga/manga.py", line 6701, in
main()
File "/home/ubuntu/komga/manga.py", line 6679, in main
check_for_existing_series()
File "/home/ubuntu/komga/manga.py", line 3554, in check_for_existing_series
done = check_upgrade(
File "/home/ubuntu/komga/manga.py", line 2910, in check_upgrade
+ array_to_string(volume.volume_number, ",")
File "/home/ubuntu/komga/manga.py", line 2661, in array_to_string
return separator.join(array)
TypeError: sequence item 0: expected str instance, float found
➜ ubuntu gdu mangaRss

I find two problems

It's my first time writing on github, so I apologize if I do something wrong. I find two problems with the script:

Does not generate a cover.jpg for cbz files.
Only works when there is a single cbz file in the path. When I use the script in a path with several .cbz files, it returns the error "IndexError: list index out of range".

I don't know if it's a script error or I'm doing something wrong. Greetings and thanks for developing this good idea.

zachstultz / komga-cover-extractor Goto Github PK