| Name | manga-dlp JSON |
| Version |
2.3.1
JSON |
| download |
| home_page | None |
| Summary | A cli manga downloader |
| upload_time | 2023-03-12 03:49:22 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
downloader
manga
mangadex
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# manga-dlp - python script to download mangas
> Full docs: https://manga-dlp.ivn.sh
CI/CD
[](https://ci.44net.ch/olofvndrhr/manga-dlp)
[](https://github.com/olofvndrhr/manga-dlp/releases)
[](https://github.com/olofvndrhr/manga-dlp/releases)
[](https://pypi.org/project/manga-dlp/)
Code Analysis
[](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Amanga-dlp)
[](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Amanga-dlp)
[](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Amanga-dlp)
[](https://app.snyk.io/org/olofvndrhr-t6h/project/aae9609d-a4e4-41f8-b1ac-f2561b2ad4e3)
Meta
[](https://github.com/psf/black)
[](https://github.com/charliermarsh/ruff)
[](https://github.com/microsoft/pyright)
[](https://github.com/pytest-dev/pytest/)
[](https://github.com/nedbat/coveragepy)
[](https://snyk.io/learn/what-is-mit-license/)
[](https://pypi.org/project/manga-dlp/)
---
## Description
A manga download script written in python. It only supports [mangadex.org](https://mangadex.org/) for now. But support
for other sites is _planned™_.
Before downloading a new chapter, the script always checks if there is already a chapter with the same name in the
download directory. If found the chapter is skipped. So you can run the script on a schedule to only download new
chapters without any additional setup.
The default behaiviour is to pack the images to a [cbz archive](https://en.wikipedia.org/wiki/Comic_book_archive). If
you just want the folder with all the pictures use the flag `--format ""`.
## _Currently_ Supported sites
- [Mangadex.org](https://mangadex.org/)
## Features (not complete)
- Metadata support with [ComicInfo.xml](https://anansi-project.github.io/docs/comicinfo/intro)
- Json caching
- Custom hooks after/before each download
- Custom chapter name format
- Volume support
- Multiple archive formats supported (cbz,cbr,zip,none)
- Language selection
- Download all chapters directly
- And others...
## Usage
### Quick start
```sh
python3 manga-dlp.py \
--url https://mangadex.org/title/a96676e5-8ae2-425e-b549-7f15dd34a6d8/komi-san-wa-komyushou-desu \
--language "en" \
--chapters "all"
```
### With GitHub
```sh
git clone https://github.com/olofvndrhr/manga-dlp.git # clone the repository
cd manga-dlp # go in the directory
pip install -r requirements.txt # install required packages
# on windows
python manga-dlp.py <options>
# on unix
python3 manga-dlp.py <options>
```
### With pip ([pypi](https://pypi.org/project/manga-dlp/))
```sh
python3 -m pip install manga-dlp # download the package from pypi
python3 -m mangadlp <args> # start the script as a module
OR
manga-dlp <args> # call script directly
OR
mangadlp <args> # call script directly
```
### With docker
See the docker [README](https://manga-dlp.ivn.sh/docker/)
## Options
```txt
Usage: manga-dlp.py [OPTIONS]
Script to download mangas from various sites
Options:
--help Show this message and exit.
--version Show the version and exit.
source: [mutually_exclusive, required]
-u, --url, --uuid TEXT URL or UUID of the manga
--read FILE Path of file with manga links to download. One per line
verbosity: [mutually_exclusive]
--loglevel INTEGER Custom log level
--warn Only log warnings and higher
--debug Debug logging. Log EVERYTHING
-c, --chapters TEXT Chapters to download
-p, --path PATH Download path [default: downloads]
-l, --language TEXT Manga language [default: en]
--list List all available chapters
--format [cbz|cbr|zip|pdf|] Archive format to create. An empty string means don't archive the folder [default: cbz]
--name-format TEXT Naming format to use when saving chapters. See docs for more infos [default: {default}]
--name-format-none TEXT String to use when the variable of the custom name format is empty
--forcevol Force naming of volumes. For mangas where chapters reset each volume
--wait FLOAT Time to wait for each picture to download in seconds(float) [default: 0.5]
--hook-manga-pre TEXT Commands to execute before the manga download starts
--hook-manga-post TEXT Commands to execute after the manga download finished
--hook-chapter-pre TEXT Commands to execute before the chapter download starts
--hook-chapter-post TEXT Commands to execute after the chapter download finished
--cache-path PATH Where to store the cache-db. If no path is given, cache is disabled
--add-metadata / --no-metadata Enable/disable creation of metadata via ComicInfo.xml [default: add-metadata]
```
## Contribution / Bugs
For suggestions for improvement, just open a pull request.
If you want to add support for a new site, there is an api [template file](contrib/api_template.py) which you can use.
And more infos and tools are in the contrib [README.md](contrib/README.md)
Otherwise, you can open an issue with the name of the site which you want support for (not guaranteed to be
implemented).
If you encounter any bugs, also just open an issue with a description of the problem.
## TODO's
- <del>Make docker container for easy distribution</del>
--> [Dockerhub](https://hub.docker.com/r/olofvndrhr/manga-dlp)
- <del>Automate release</del>
--> Done with woodpecker-ci
- <del>Make pypi package</del>
--> Done with release [2.1.7](https://pypi.org/project/manga-dlp/)
- Add more supported sites
Raw data
{
"_id": null,
"home_page": null,
"name": "manga-dlp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "downloader,manga,mangadex",
"author": null,
"author_email": "Ivan Schaller <ivan@schaller.sh>",
"download_url": "https://files.pythonhosted.org/packages/60/cd/58ce9f467bfea1b9bfe1c91601f738f3859626691d5f13a61d2fe5a0b4f1/manga_dlp-2.3.1.tar.gz",
"platform": null,
"description": "# manga-dlp - python script to download mangas\n\n> Full docs: https://manga-dlp.ivn.sh\n\nCI/CD\n\n[](https://ci.44net.ch/olofvndrhr/manga-dlp)\n[](https://github.com/olofvndrhr/manga-dlp/releases)\n[](https://github.com/olofvndrhr/manga-dlp/releases)\n[](https://pypi.org/project/manga-dlp/)\n\nCode Analysis\n\n[](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Amanga-dlp)\n[](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Amanga-dlp)\n[](https://sonarqube.44net.ch/dashboard?id=olofvndrhr%3Amanga-dlp)\n[](https://app.snyk.io/org/olofvndrhr-t6h/project/aae9609d-a4e4-41f8-b1ac-f2561b2ad4e3)\n\nMeta\n\n[](https://github.com/psf/black)\n[](https://github.com/charliermarsh/ruff)\n[](https://github.com/microsoft/pyright)\n[](https://github.com/pytest-dev/pytest/)\n[](https://github.com/nedbat/coveragepy)\n[](https://snyk.io/learn/what-is-mit-license/)\n[](https://pypi.org/project/manga-dlp/)\n\n---\n\n## Description\n\nA manga download script written in python. It only supports [mangadex.org](https://mangadex.org/) for now. But support\nfor other sites is _planned\u2122_.\n\nBefore downloading a new chapter, the script always checks if there is already a chapter with the same name in the\ndownload directory. If found the chapter is skipped. So you can run the script on a schedule to only download new\nchapters without any additional setup.\n\nThe default behaiviour is to pack the images to a [cbz archive](https://en.wikipedia.org/wiki/Comic_book_archive). If\nyou just want the folder with all the pictures use the flag `--format \"\"`.\n\n## _Currently_ Supported sites\n\n- [Mangadex.org](https://mangadex.org/)\n\n## Features (not complete)\n\n- Metadata support with [ComicInfo.xml](https://anansi-project.github.io/docs/comicinfo/intro)\n- Json caching\n- Custom hooks after/before each download\n- Custom chapter name format\n- Volume support\n- Multiple archive formats supported (cbz,cbr,zip,none)\n- Language selection\n- Download all chapters directly\n- And others...\n\n## Usage\n\n### Quick start\n\n```sh\npython3 manga-dlp.py \\\n --url https://mangadex.org/title/a96676e5-8ae2-425e-b549-7f15dd34a6d8/komi-san-wa-komyushou-desu \\\n --language \"en\" \\\n --chapters \"all\"\n```\n\n### With GitHub\n\n```sh\ngit clone https://github.com/olofvndrhr/manga-dlp.git # clone the repository\n\ncd manga-dlp # go in the directory\n\npip install -r requirements.txt # install required packages\n\n# on windows\npython manga-dlp.py <options>\n# on unix\npython3 manga-dlp.py <options>\n```\n\n### With pip ([pypi](https://pypi.org/project/manga-dlp/))\n\n```sh\npython3 -m pip install manga-dlp # download the package from pypi\n\npython3 -m mangadlp <args> # start the script as a module\nOR\nmanga-dlp <args> # call script directly\nOR\nmangadlp <args> # call script directly\n```\n\n### With docker\n\nSee the docker [README](https://manga-dlp.ivn.sh/docker/)\n\n## Options\n\n```txt\nUsage: manga-dlp.py [OPTIONS]\n\nScript to download mangas from various sites\n\nOptions:\n--help Show this message and exit.\n--version Show the version and exit.\nsource: [mutually_exclusive, required]\n-u, --url, --uuid TEXT URL or UUID of the manga\n--read FILE Path of file with manga links to download. One per line\nverbosity: [mutually_exclusive]\n--loglevel INTEGER Custom log level\n--warn Only log warnings and higher\n--debug Debug logging. Log EVERYTHING\n-c, --chapters TEXT Chapters to download\n-p, --path PATH Download path [default: downloads]\n-l, --language TEXT Manga language [default: en]\n--list List all available chapters\n--format [cbz|cbr|zip|pdf|] Archive format to create. An empty string means don't archive the folder [default: cbz]\n--name-format TEXT Naming format to use when saving chapters. See docs for more infos [default: {default}]\n--name-format-none TEXT String to use when the variable of the custom name format is empty\n--forcevol Force naming of volumes. For mangas where chapters reset each volume\n--wait FLOAT Time to wait for each picture to download in seconds(float) [default: 0.5]\n--hook-manga-pre TEXT Commands to execute before the manga download starts\n--hook-manga-post TEXT Commands to execute after the manga download finished\n--hook-chapter-pre TEXT Commands to execute before the chapter download starts\n--hook-chapter-post TEXT Commands to execute after the chapter download finished\n--cache-path PATH Where to store the cache-db. If no path is given, cache is disabled\n--add-metadata / --no-metadata Enable/disable creation of metadata via ComicInfo.xml [default: add-metadata]\n```\n\n## Contribution / Bugs\n\nFor suggestions for improvement, just open a pull request.\n\nIf you want to add support for a new site, there is an api [template file](contrib/api_template.py) which you can use.\nAnd more infos and tools are in the contrib [README.md](contrib/README.md)\n\nOtherwise, you can open an issue with the name of the site which you want support for (not guaranteed to be\nimplemented).\n\nIf you encounter any bugs, also just open an issue with a description of the problem.\n\n## TODO's\n\n- <del>Make docker container for easy distribution</del>\n --> [Dockerhub](https://hub.docker.com/r/olofvndrhr/manga-dlp)\n- <del>Automate release</del>\n --> Done with woodpecker-ci\n- <del>Make pypi package</del>\n --> Done with release [2.1.7](https://pypi.org/project/manga-dlp/)\n- Add more supported sites\n",
"bugtrack_url": null,
"license": null,
"summary": "A cli manga downloader",
"version": "2.3.1",
"split_keywords": [
"downloader",
"manga",
"mangadex"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d7478c94c0f1f4ecb106ff47984a762368b10a5a275df197a72723efc915b339",
"md5": "ac649970ac9ccaa1b7dafde77923cadd",
"sha256": "21d3789c86101172fdd5853ba59300ecb601f29dde590bc03d81eb4e5c996825"
},
"downloads": -1,
"filename": "manga_dlp-2.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac649970ac9ccaa1b7dafde77923cadd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23949,
"upload_time": "2023-03-12T03:49:20",
"upload_time_iso_8601": "2023-03-12T03:49:20.462413Z",
"url": "https://files.pythonhosted.org/packages/d7/47/8c94c0f1f4ecb106ff47984a762368b10a5a275df197a72723efc915b339/manga_dlp-2.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "60cd58ce9f467bfea1b9bfe1c91601f738f3859626691d5f13a61d2fe5a0b4f1",
"md5": "74c8f97522e94a38ca657e5ef912063b",
"sha256": "b58095061f26ae4be54c242ad414e5891a394e14406cb09a758593a3c2e63501"
},
"downloads": -1,
"filename": "manga_dlp-2.3.1.tar.gz",
"has_sig": false,
"md5_digest": "74c8f97522e94a38ca657e5ef912063b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20528,
"upload_time": "2023-03-12T03:49:22",
"upload_time_iso_8601": "2023-03-12T03:49:22.664083Z",
"url": "https://files.pythonhosted.org/packages/60/cd/58ce9f467bfea1b9bfe1c91601f738f3859626691d5f13a61d2fe5a0b4f1/manga_dlp-2.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-12 03:49:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "manga-dlp"
}
