mangadex-downloader


Namemangadex-downloader JSON
Version 2.10.3 PyPI version JSON
download
home_pagehttps://github.com/mansuf/mangadex-downloader
SummaryA Command-line tool to download manga from MangaDex, written in Python
upload_time2023-07-09 06:31:55
maintainer
docs_urlNone
authorRahman Yusuf
requires_python>=3.8
licenseMIT
keywords mangadex
VCS
bugtrack_url
requirements requests-doh requests tqdm pathvalidate packaging pyjwt beautifulsoup4 Pillow chardet
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pypi-total-downloads](https://img.shields.io/pypi/dm/mangadex-downloader?label=DOWNLOADS&style=for-the-badge)](https://pypi.org/project/mangadex-downloader)
[![python-ver](https://img.shields.io/pypi/pyversions/mangadex-downloader?style=for-the-badge)](https://pypi.org/project/mangadex-downloader)
[![pypi-release-ver](https://img.shields.io/pypi/v/mangadex-downloader?style=for-the-badge)](https://pypi.org/project/mangadex-downloader)

# mangadex-downloader

[![Indonesian](https://img.shields.io/badge/Language-Indonesian-blue.svg)](https://github.com/mansuf/mangadex-downloader/blob/main/README.id.md)
[![Turkish](https://img.shields.io/badge/Language-Turkish-blue.svg)](https://github.com/mansuf/mangadex-downloader/blob/main/README.tr.md)

A command-line tool to download manga from [MangaDex](https://mangadex.org/), written in [Python](https://www.python.org/).

## Table of Contents

- [Key Features](#key-features)
- [Supported formats](#supported-formats)
- [Installation](#installation)
    - [Python Package Index (PyPI)](#installation-pypi)
    - [Bundled executable](#installation-bundled-executable)
    - [Development version](#installation-development-version)
- [Usage](#usage)
    - [PyPI version](#usage-pypi-version)
    - [Bundled executable version](#usage-bundled-executable-version)
- [Contributing](#contributing)
- [Donation](#donation)
- [Links](#links)
- [Disclaimer](#disclaimer)

## Key Features <a id="key-features"></a>

- Download manga, cover manga, chapter, or list directly from MangaDex
- Download manga or list from user library
- Find and download MangaDex URLs from MangaDex forums ([https://forums.mangadex.org/](https://forums.mangadex.org/))
- Batch download support
- Legacy MangaDex url support
- Scanlation groups filter support
- Authentication support
- Control how many chapters and pages you want to download
- Compressed images support
- HTTP / SOCKS proxy support
- DNS-over-HTTPS support
- Multi languages support
- Save as raw images, EPUB, PDF, Comic Book Archive (.cbz or .cb7)

***And ability to not download oneshot chapter***

## Supported formats <a id="supported-formats"></a>

[Read here](https://mangadex-dl.mansuf.link/en/latest/formats.html) for more info.

## Installation <a id="installation"></a>

What will you need:

- Python 3.8.x or up with Pip (if you are in Windows, you can download bundled executable. [See this instructions how to install it](#installation-bundled-executable))

That's it.

### Python Package Index (PyPI) <a id="installation-pypi"></a>

Installing mangadex-downloader is easy, as long as you have requirements above.

```shell
# For Windows
py -3 -m pip install mangadex-downloader

# For Linux / Mac OS
python3 -m pip install mangadex-downloader
```

You can also install optional dependencies

- [py7zr](https://pypi.org/project/py7zr/) for cb7 support
- [orjson](https://pypi.org/project/orjson/) for maximum performance (fast JSON library)
- [lxml](https://pypi.org/project/lxml/) for EPUB support

Or you can install all optional dependencies

```shell
# For Windows
py -3 -m pip install mangadex-downloader[optional]

# For Mac OS / Linux
python3 -m pip install mangadex-downloader[optional]
```

There you go, easy ain't it ?.

### Bundled executable <a id="installation-bundled-executable"></a>

**NOTE:** This installation only apply to Windows.

Because this is bundled executable, Python are not required to install.

Steps:

- Download latest version here -> https://github.com/mansuf/mangadex-downloader/releases
- Extract it.
- That's it ! You have successfully install mangadex-downloader. 
[See this instructions to run mangadex-downloader](#usage-bundled-executable-version)

### Development version <a id="installation-development-version"></a>

**NOTE:** You must have git installed. If you don't have it, install it from here https://git-scm.com/.

```shell
git clone https://github.com/mansuf/mangadex-downloader.git
cd mangadex-downloader
python setup.py install # or "pip install ."
```

## Usage <a id="usage"></a>

### PyPI version <a id="usage-pypi-version"></a>

```shell

mangadex-dl "insert MangaDex URL here" 
# or
mangadex-downloader "insert MangaDex URL here" 

# Use this if "mangadex-dl" or "mangadex-downloader" didn't work

# For Windows
py -3 -m mangadex_downloader "insert MangaDex URL here" 

# For Linux / Mac OS
python3 -m mangadex_downloader "insert MangaDex URL here" 
```

### Bundled executable version <a id="usage-bundled-executable-version"></a>

- Navigate to folder where you downloaded mangadex-downloader
- Open "start cmd.bat" (don't worry it's not a virus, it will open a command prompt)

![example_start_cmd](https://raw.githubusercontent.com/mansuf/mangadex-downloader/main/assets/example_start_cmd.png)

- And then start using mangadex-downloader, see example below:

```shell
mangadex-dl.exe "insert MangaDex URL here" 
```

![example_usage_executable](https://raw.githubusercontent.com/mansuf/mangadex-downloader/main/assets/example_usage_executable.png)

For more example usage, you can [read here](https://mangadex-dl.mansuf.link/en/stable/cli_usage/index.html)

For more info about CLI options, you can [read here](https://mangadex-dl.mansuf.link/en/stable/cli_ref/index.html)

## Contributing <a id="contributing"></a>

See [CONTRIBUTING.md](https://github.com/mansuf/mangadex-downloader/blob/main/CONTRIBUTING.md) for more info

## Donation <a id="donation"></a>

If you like this project, please consider donate to one of these websites:

- [Sociabuzz](https://sociabuzz.com/mansuf/donate)
- [Ko-fi](https://ko-fi.com/rahmanyusuf)
- [Github Sponsor](https://github.com/sponsors/mansuf)

Any donation amount will be appreciated 💖

## Links <a id="links"></a>

- [PyPI](https://pypi.org/project/mangadex-downloader/)
- [Docs](https://mangadex-dl.mansuf.link)

## Disclaimer <a id="disclaimer"></a>

mangadex-downloader are not affiliated with MangaDex. Also, the current maintainer ([@mansuf](https://github.com/mansuf)) is not a MangaDex dev

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mansuf/mangadex-downloader",
    "name": "mangadex-downloader",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "mangadex",
    "author": "Rahman Yusuf",
    "author_email": "danipart4@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/5e/ad/5e63c61fffecf7ad0ad0de1d6a0093726fd5f3b287070f8ed38a8a210d63/mangadex-downloader-2.10.3.tar.gz",
    "platform": null,
    "description": "[![pypi-total-downloads](https://img.shields.io/pypi/dm/mangadex-downloader?label=DOWNLOADS&style=for-the-badge)](https://pypi.org/project/mangadex-downloader)\n[![python-ver](https://img.shields.io/pypi/pyversions/mangadex-downloader?style=for-the-badge)](https://pypi.org/project/mangadex-downloader)\n[![pypi-release-ver](https://img.shields.io/pypi/v/mangadex-downloader?style=for-the-badge)](https://pypi.org/project/mangadex-downloader)\n\n# mangadex-downloader\n\n[![Indonesian](https://img.shields.io/badge/Language-Indonesian-blue.svg)](https://github.com/mansuf/mangadex-downloader/blob/main/README.id.md)\n[![Turkish](https://img.shields.io/badge/Language-Turkish-blue.svg)](https://github.com/mansuf/mangadex-downloader/blob/main/README.tr.md)\n\nA command-line tool to download manga from [MangaDex](https://mangadex.org/), written in [Python](https://www.python.org/).\n\n## Table of Contents\n\n- [Key Features](#key-features)\n- [Supported formats](#supported-formats)\n- [Installation](#installation)\n    - [Python Package Index (PyPI)](#installation-pypi)\n    - [Bundled executable](#installation-bundled-executable)\n    - [Development version](#installation-development-version)\n- [Usage](#usage)\n    - [PyPI version](#usage-pypi-version)\n    - [Bundled executable version](#usage-bundled-executable-version)\n- [Contributing](#contributing)\n- [Donation](#donation)\n- [Links](#links)\n- [Disclaimer](#disclaimer)\n\n## Key Features <a id=\"key-features\"></a>\n\n- Download manga, cover manga, chapter, or list directly from MangaDex\n- Download manga or list from user library\n- Find and download MangaDex URLs from MangaDex forums ([https://forums.mangadex.org/](https://forums.mangadex.org/))\n- Batch download support\n- Legacy MangaDex url support\n- Scanlation groups filter support\n- Authentication support\n- Control how many chapters and pages you want to download\n- Compressed images support\n- HTTP / SOCKS proxy support\n- DNS-over-HTTPS support\n- Multi languages support\n- Save as raw images, EPUB, PDF, Comic Book Archive (.cbz or .cb7)\n\n***And ability to not download oneshot chapter***\n\n## Supported formats <a id=\"supported-formats\"></a>\n\n[Read here](https://mangadex-dl.mansuf.link/en/latest/formats.html) for more info.\n\n## Installation <a id=\"installation\"></a>\n\nWhat will you need:\n\n- Python 3.8.x or up with Pip (if you are in Windows, you can download bundled executable. [See this instructions how to install it](#installation-bundled-executable))\n\nThat's it.\n\n### Python Package Index (PyPI) <a id=\"installation-pypi\"></a>\n\nInstalling mangadex-downloader is easy, as long as you have requirements above.\n\n```shell\n# For Windows\npy -3 -m pip install mangadex-downloader\n\n# For Linux / Mac OS\npython3 -m pip install mangadex-downloader\n```\n\nYou can also install optional dependencies\n\n- [py7zr](https://pypi.org/project/py7zr/) for cb7 support\n- [orjson](https://pypi.org/project/orjson/) for maximum performance (fast JSON library)\n- [lxml](https://pypi.org/project/lxml/) for EPUB support\n\nOr you can install all optional dependencies\n\n```shell\n# For Windows\npy -3 -m pip install mangadex-downloader[optional]\n\n# For Mac OS / Linux\npython3 -m pip install mangadex-downloader[optional]\n```\n\nThere you go, easy ain't it ?.\n\n### Bundled executable <a id=\"installation-bundled-executable\"></a>\n\n**NOTE:** This installation only apply to Windows.\n\nBecause this is bundled executable, Python are not required to install.\n\nSteps:\n\n- Download latest version here -> https://github.com/mansuf/mangadex-downloader/releases\n- Extract it.\n- That's it ! You have successfully install mangadex-downloader. \n[See this instructions to run mangadex-downloader](#usage-bundled-executable-version)\n\n### Development version <a id=\"installation-development-version\"></a>\n\n**NOTE:** You must have git installed. If you don't have it, install it from here https://git-scm.com/.\n\n```shell\ngit clone https://github.com/mansuf/mangadex-downloader.git\ncd mangadex-downloader\npython setup.py install # or \"pip install .\"\n```\n\n## Usage <a id=\"usage\"></a>\n\n### PyPI version <a id=\"usage-pypi-version\"></a>\n\n```shell\n\nmangadex-dl \"insert MangaDex URL here\" \n# or\nmangadex-downloader \"insert MangaDex URL here\" \n\n# Use this if \"mangadex-dl\" or \"mangadex-downloader\" didn't work\n\n# For Windows\npy -3 -m mangadex_downloader \"insert MangaDex URL here\" \n\n# For Linux / Mac OS\npython3 -m mangadex_downloader \"insert MangaDex URL here\" \n```\n\n### Bundled executable version <a id=\"usage-bundled-executable-version\"></a>\n\n- Navigate to folder where you downloaded mangadex-downloader\n- Open \"start cmd.bat\" (don't worry it's not a virus, it will open a command prompt)\n\n![example_start_cmd](https://raw.githubusercontent.com/mansuf/mangadex-downloader/main/assets/example_start_cmd.png)\n\n- And then start using mangadex-downloader, see example below:\n\n```shell\nmangadex-dl.exe \"insert MangaDex URL here\" \n```\n\n![example_usage_executable](https://raw.githubusercontent.com/mansuf/mangadex-downloader/main/assets/example_usage_executable.png)\n\nFor more example usage, you can [read here](https://mangadex-dl.mansuf.link/en/stable/cli_usage/index.html)\n\nFor more info about CLI options, you can [read here](https://mangadex-dl.mansuf.link/en/stable/cli_ref/index.html)\n\n## Contributing <a id=\"contributing\"></a>\n\nSee [CONTRIBUTING.md](https://github.com/mansuf/mangadex-downloader/blob/main/CONTRIBUTING.md) for more info\n\n## Donation <a id=\"donation\"></a>\n\nIf you like this project, please consider donate to one of these websites:\n\n- [Sociabuzz](https://sociabuzz.com/mansuf/donate)\n- [Ko-fi](https://ko-fi.com/rahmanyusuf)\n- [Github Sponsor](https://github.com/sponsors/mansuf)\n\nAny donation amount will be appreciated \ud83d\udc96\n\n## Links <a id=\"links\"></a>\n\n- [PyPI](https://pypi.org/project/mangadex-downloader/)\n- [Docs](https://mangadex-dl.mansuf.link)\n\n## Disclaimer <a id=\"disclaimer\"></a>\n\nmangadex-downloader are not affiliated with MangaDex. Also, the current maintainer ([@mansuf](https://github.com/mansuf)) is not a MangaDex dev\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Command-line tool to download manga from MangaDex, written in Python",
    "version": "2.10.3",
    "project_urls": {
        "Download": "https://github.com/mansuf/mangadex-downloader/releases",
        "Homepage": "https://github.com/mansuf/mangadex-downloader"
    },
    "split_keywords": [
        "mangadex"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7e82ad48ad42d3770b4360250ace03d8cd57aa9419e0f9113bafc22e9cc4a64e",
                "md5": "25eb7965cf87b8f33f88c341641ee656",
                "sha256": "a42504f16616cea6a2af8f42661804b6764a1ba81c6e8063dd1f25391d8ba1d0"
            },
            "downloads": -1,
            "filename": "mangadex_downloader-2.10.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "25eb7965cf87b8f33f88c341641ee656",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3078987,
            "upload_time": "2023-07-09T06:31:53",
            "upload_time_iso_8601": "2023-07-09T06:31:53.326569Z",
            "url": "https://files.pythonhosted.org/packages/7e/82/ad48ad42d3770b4360250ace03d8cd57aa9419e0f9113bafc22e9cc4a64e/mangadex_downloader-2.10.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5ead5e63c61fffecf7ad0ad0de1d6a0093726fd5f3b287070f8ed38a8a210d63",
                "md5": "771832283d9d576fd6baf86e1fdf5e90",
                "sha256": "44cd540a753bfcff75de0ec77d3099a75ebaff49ac2b73a47c4c4977d042a4eb"
            },
            "downloads": -1,
            "filename": "mangadex-downloader-2.10.3.tar.gz",
            "has_sig": false,
            "md5_digest": "771832283d9d576fd6baf86e1fdf5e90",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3029365,
            "upload_time": "2023-07-09T06:31:55",
            "upload_time_iso_8601": "2023-07-09T06:31:55.674863Z",
            "url": "https://files.pythonhosted.org/packages/5e/ad/5e63c61fffecf7ad0ad0de1d6a0093726fd5f3b287070f8ed38a8a210d63/mangadex-downloader-2.10.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-09 06:31:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mansuf",
    "github_project": "mangadex-downloader",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests-doh",
            "specs": [
                [
                    "==",
                    "0.3.1"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "tqdm",
            "specs": []
        },
        {
            "name": "pathvalidate",
            "specs": []
        },
        {
            "name": "packaging",
            "specs": []
        },
        {
            "name": "pyjwt",
            "specs": []
        },
        {
            "name": "beautifulsoup4",
            "specs": []
        },
        {
            "name": "Pillow",
            "specs": [
                [
                    "==",
                    "9.5.0"
                ]
            ]
        },
        {
            "name": "chardet",
            "specs": []
        }
    ],
    "lcname": "mangadex-downloader"
}
        
Elapsed time: 0.08795s