Skip to content

Berkwe/mandown

 
 

Repository files navigation

mandown

Supported Python versions Checked with mypy Download from PyPI Download from the AUR Latest release License

Mandown is a comic downloader and a CBZ, EPUB, MOBI, and/or PDF converter. It also supports image post-processing to make them more readable on certain devices similarly to Kindle Comic Converter.

Features

  • Download comics from supported sites
    • Supports downloading a range of chapters
    • Supports multithreaded downloading
  • Process downloaded images
    • Rotate or split double-page spreads
    • Trim borders
    • Resize images
  • Convert downloaded comics to CBZ, EPUB, MOBI, or PDF
    • Convert any other CBZ, EPUB, MOBI, or PDF comic to CBZ, EPUB, MOBI, or PDF
  • A library to easily do all of this from other Python scripts

Usage

Run mandown --help or see the docs for more information and examples.

mandown get <URL>

To convert the downloaded contents to CBZ/EPUB/MOBI/PDF, append the --convert option. To apply image processing to the downloaded images, append the --process option.

mandown get <URL> --convert epub --process rotate_double_pages

To download only a certain range of chapters, append the --start and/or --end options.

Note: --start and --end are inclusive, i.e., using --start 2 --end 3 will download chapters 2 and 3.

To convert an existing folder or comic file without downloading anything (like a stripped-down version of https://github.com/ciromattia/kcc), use the convert command.

mandown convert <FORMAT> <PATH_TO_COMIC>

To process an existing folder without downloading anything, use the process command.

mandown process <PROCESS_OPERATIONS> <PATH_TO_FOLDER>

Where PROCESS_OPERATIONS is an option found from running mandown process --help.

Installation

Install the package from PyPI:

pip3 install git+https://github.com/Berkwe/mandown

Install the optional large dependencies for some features of Mandown:

# graphical interface (GUI)
pip3 install PySide6

Arch Linux users may also install the package from the AUR:

git clone https://aur.archlinux.org/mandown-git.git
makepkg -si

Or, to build from source:

Mandown uses poetry for dependency management.

git clone https://github.com/Berkwe/mandown
poetry install
poetry build
pip3 install dist/mandown*.whl

Supported sites

To request a new site, please file a new issue.

Basic library usage

See the Python API guide for the main functions, arguments, return values, and examples. The topic guides contain more information about downloading, processing, and conversion.

To just download the images:

import mandown

mandown.download("https://comic-site.com/the-best-comic")

To download and convert to EPUB:

import mandown

comic = mandown.query("https://comic-site.com/the-best-comic")
mandown.download(comic)
mandown.convert(comic, title=comic.metadata.title, to="epub")

About

Comic/manga/webtoon downloader and CBZ/EPUB/MOBI/PDF converter

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages