MangaDM - Manga Download Manager

MangaDM is a command-line tool and Python library for downloading manga chapters based on the metadata specified in a JSON file.

Installation

To install the MangaDM, you need to have Python installed on your system. You can then use pip to install from the source code or from a distribution package.

Install from Source

1. Clone the repository:

   git clone https://github.com/xMohnad/MangaDM.git
   cd MangaDM

2. Install the tool:

   pip install .

Install from Distribution Package

If you have a .tar.gz file, you can install it using pip:

pip install dist/MangaDM-x.x.tar.gz

• or .whl

pip install dist/MangaDM-x.x-py3-none-any.whl

Usage

Once installed, you can use the mangadm command to download manga chapters. Here are the available options

Example Commands

mangadm [OPTIONS] [JSON_FILE]

Basic Usage

mangadm /path/to/manga.json

This command will download all chapters specified in the manga.json file to the current directory.

Specify Destination Path

mangadm /path/to/manga.json --dest /path/to/save

This command will download all chapters to the specified destination path.

Limit Number of Chapters

mangadm /path/to/manga.json --limit 10

This command will download only the first 10 chapters.

Force Re-download of Existing Files

mangadm /path/to/manga.json --force

This command will re-download files even if they already exist.

Delete Data After Successful Download

mangadm /path/to/manga.json --delete

This command will delete the chapter data from the JSON file after a successful download.

Download and Save as CBZ

mangadm /path/to/manga.json --cbz

This command will download the chapters and save them in CBZ format.

Enable Transient Mode

mangadm /path/to/manga.json --transient

This command will enable transient mode, where progress indicators are not persisted after the download process completes.

Set and Save Default Settings

To set and save your current settings as the default, use the --set-settings option:

mangadm /path/to/manga.json --dest /path/to/save --limit 10 --force --delete --set-settings

• or

mangadm /path/to/manga.json --dest /path/to/save --limit 10 --no-force --no-delete --set-settings

This command will save the current settings (destination path, chapter limit, force re-download, delete on success) as the default for future downloads.

Open Configuration UI

mangadm --configure

This command will open a text-based user interface (UI) that allows you to set up or change your settings interactively.

View Current Settings

mangadm --settings

This command will display the current default settings.

Options

• --dest or -p: Destination path for downloading manga chapters. Default is the current directory.
• --limit or -l: Number of chapters to download. If -1, download all chapters. Default is -1.
• --force/--no-force or -f: Re-download chapter if not complete.
• --delete/--no-delete or -d: Delete chapter data from JSON after successful download.
• --cbz/--no-cbz or -z: when enabled, saves the downloaded chapters in CBZ format.
• --transient/--no-transient or -t: Activate transient mode (progress bar will disappear after completion).
• --set-settings or -s: Save the current settings as default.
• --example or -e: Display an example JSON structure for the input file.
• --configure or -c: when enabled, opens a text-based user interface to configure or change settings.
• --settings: Display the current settings.
• --help or -h

Example JSON Structure

If you want to see an example of the expected JSON structure for the input file, you can use the --example option:

mangadm --example

Using MangaDM as a Library

You can also use MangaDM as a Python library. Here’s how you can use it programmatically:

Example Usage

from mangadm import MangaDM

# Create an instance of MangaDM with desired parameters
mangadm = MangaDM(
    json_file="path/to/yourfile.json",
    dest_path="path/to/chapter",
    chapters_limit=1,
    delete_on_success=False,
    force_download=False,
    save_as_CBZ=True,
    transient=False
)

# Start the downloading process
mangadm.start()

Parameters

• json_file (str): The path to the JSON file containing manga data.
• dest_path (str): The destination path where manga chapters will be downloaded. Defaults to the current directory.
• chapters_limit (int): Number of chapters to download. If -1, download all chapters. Defaults to -1.
• force_download (bool): If True, re-download files even if they exist. Defaults to False.
• delete_on_success (bool): If True, delete chapter data from JSON after successful download. Defaults to False.
• save_as_CBZ (bool): If True, the downloaded chapters will be saved in CBZ format, Defaults to False.
• transient (bool): If True, activates transient mode. This mode ensures that progress indicators are not persisted after the process completes. Defaults to False.

Example JSON Structure

Here’s an example of the JSON structure required for the input file:

[
    {
        "manganame": "Jujutsu Kaisen",
        "cover": "https://example.com/cover.jpg",
        "title": "Jujutsu Kaisen - 256",
        "images": [
            "https://example.com/image1.jpg",
            "https://example.com/image2.jpg",
            "https://example.com/image3.jpg"
        ]
    },
    {
        "manganame": "Boruto",
        "cover": "https://example.com/cover.jpg",
        "title": "Boruto - 7",
        "images": [
            "https://example.com/image1.jpg",
            "https://example.com/image2.jpg",
            "https://example.com/image3.jpg"
        ]
    }
]

The JSON structure provided earlier is a simplified example of how you should format your input file for the MangaDM tool. Each manga entry contains the following keys:

• manganame: The name of the manga series.
• cover: A URL to the cover image of the manga chapter. This is optional but can be used to enhance the metadata.
• title: The title of the specific manga chapter.
• images: An list of URLs, where each URL points to an image file (usually pages of the manga chapter).

You can add as many manga entries as needed, and the tool will process each entry sequentially based on the options provided.

Contributing

Bug Reports & Feature Requests

If you encounter any issues while using MangaDM or have suggestions for new features, you can open an issue on the GitHub repository. Please provide detailed information about the issue or feature request to help in resolving it more effectively.

License

MangaDM is open-source software licensed under the MIT License. This means you can freely use, modify, and distribute the tool, provided you include the original license and copyright notice in any distributions or derivative works.