Metadata-Version: 2.2
Name: h2hdb-komga
Version: 0.0.1
Author: Kuan-Lun Wang
License: GNU Affero General Public License v3
Project-URL: Homepage, https://github.com/Kuan-Lun/h2hdb-komga
Project-URL: Source, https://github.com/Kuan-Lun/h2hdb-komga
Project-URL: Tracker, https://github.com/Kuan-Lun/h2hdb-komga/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h2hdb<2.0.0.0,>=0.7.0.9
Requires-Dist: requests<3.0.0,>=2.32.3

# H2HDB-Komga

## Description

The `H2HDB-Komga` is a tool that adds tags to comics and renames series in a specified library within Komga. It uses tags from [`H2HDB`](https://github.com/Kuan-Lun/h2hdb) to help you organise and tag your comics and series in the library in Komga.

---

## Installation and Usage

1. Install Python 3.13 or higher from [python.org](https://www.python.org/downloads/).
1. Install the required packages.

    ```bash
    pip install h2hdb-komga
    ```

1. Run the script.

    ```bash
    python -m h2hdb_komga --komgaconfig [komga-config.json] --h2hdbconfig [h2hdb-config.json]
    ```

### Config

#### komga-config.json

```json
{
    "base_url": "[str]", // The url of komga.
    "api_username": "[str]", // The administrator account of komga.
    "api_password": "[str]", // The password of the administrator account of komga.
    "library_id": "[str]" // The libary ID of komga.
}
```

#### h2hdb-config.json

See [Subsection Config in Kuan-Lun/h2hdb](https://github.com/Kuan-Lun/h2hdb#config).

---

## Q & A

- How to use Komga?
See [Rainie's article](https://home.gamer.com.tw/artwork.php?sn=5659465).

- Why aren't the tags for CBZ-files in Komga updated?
When you first run `H2HDB`, it generates CBZ-files. These CBZ-files are not immediately visible in Komga's library. To update them, you have two options: you can either click the 'scan library files' button in Komga, or you can run `H2HDB` twice. The first run scans the library, and the second run updates the tags.

---

## Credits

The project was created by [Kuan-Lun Wang](https://www.klwang.tw/home/).

---

## License

This project is distributed under the terms of the GNU General Public Licence (GPL). For detailed licence terms, see the `LICENSE` file included in this distribution.
