138 lines
6.9 KiB
Markdown
138 lines
6.9 KiB
Markdown
# manga-dlp - python script to download mangas
|
|
|
|
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://pylint.pycqa.org/en/latest/)
|
|
[](https://github.com/python/mypy)
|
|
[](https://github.com/pycqa/isort)
|
|
[](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 `--nocbz`.
|
|
|
|
## _Currently_ Supported sites
|
|
|
|
- [Mangadex.org](https://mangadex.org/)
|
|
|
|
## 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 [-h] (-u URL_UUID | --read READ | -v) [-c CHAPTERS] [-p PATH] [-l LANG] [--list] [--format FORMAT] [--forcevol] [--wait WAIT] [--lean | --verbose | --debug] [--hook-manga-pre HOOK_MANGA_PRE]
|
|
[--hook-manga-post HOOK_MANGA_POST] [--hook-chapter-pre HOOK_CHAPTER_PRE] [--hook-chapter-post HOOK_CHAPTER_POST]
|
|
|
|
Script to download mangas from various sites
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
-u URL_UUID, --url URL_UUID, --uuid URL_UUID URL or UUID of the manga
|
|
--read READ Path of file with manga links to download. One per line
|
|
-v, --version Show version of manga-dlp and exit
|
|
-c CHAPTERS, --chapters CHAPTERS Chapters to download
|
|
-p PATH, --path PATH Download path. Defaults to "<script_dir>/downloads"
|
|
-l LANG, --language LANG Manga language. Defaults to "en" --> english
|
|
--list List all available chapters. Defaults to false
|
|
--format FORMAT Archive format to create. An empty string means dont archive the folder. Defaults to 'cbz'
|
|
--forcevol Force naming of volumes. For mangas where chapters reset each volume
|
|
--wait WAIT Time to wait for each picture to download in seconds(float). Defaults 0.5
|
|
--lean Lean logging. Minimal log output. Defaults to false
|
|
--verbose Verbose logging. More log output. Defaults to false
|
|
--debug Debug logging. Most log output. Defaults to false
|
|
--hook-manga-pre HOOK_MANGA_PRE Commands to execute before the manga download starts
|
|
--hook-manga-post HOOK_MANGA_POST Commands to execute after the manga download finished
|
|
--hook-chapter-pre HOOK_CHAPTER_PRE Commands to execute before the chapter download starts
|
|
--hook-chapter-post HOOK_CHAPTER_POST Commands to execute after the chapter download finished
|
|
```
|
|
|
|
## 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](https://github.com/olofvndrhr/manga-dlp/blob/master/contrib/api_template.py) which you can use.
|
|
And more infos and tools in the
|
|
contrib [README.md](https://github.com/olofvndrhr/manga-dlp/blob/master/contrib/README.md)
|
|
|
|
Otherwise, you can open am 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/repository/docker/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
|