README.rst

   1 Manga-py |Travis CI result stable1.x|
   2 ==========================================
   3
   4 Universal assistant download manga.
   5 '''''''''''''''''''''''''''''''''''
   6
   7 Approximately 200+ providers are available now.
   8 '''''''''''''''''''''''''''''''''''''''''''''''
   9
  10 |Scrutinizer CI result| |Scrutinizer CI coverage| |GitHub issues| |Travis CI result|
  11
  12 |Code Climate| |Issue Count|
  13
  14 |GitHub repo size| |PyPI - size|
  15
  16 |PyPI - Python Version| |PyPi version| |PyPI - Downloads|
  17
  18 Supported resources
  19 -------------------
  20
  21 see:
  22
  23 - https://manga-py.com/manga-py/#resources-list
  24 - https://manga-py.github.io/manga-py/#resources-list (alternative)
  25 - https://yuru-yuri.github.io/manga-py/#resources-list (deprecated)
  26
  27
  28 Thanks for support
  29 ~~~~~~~~~~~~~~~~~~
  30 1. Robert M.
  31
  32
  33 How to use
  34 ----------
  35
  36 Installation
  37 ~~~~~~~~~~~~
  38
  39 1) Download python 3.6+ https://docs.conda.io/en/latest/miniconda.html
  40 2) Install pip package:
  41
  42 .. code:: bash
  43
  44    pip install manga-py
  45
  46 3) Run program:
  47
  48 .. code:: bash
  49
  50     manga-py http://manga.url/manga/name  # For download manga
  51
  52 Installation on the Android
  53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  54 See https://github.com/manga-py/manga-py/issues/48
  55
  56 Docker image:
  57 ~~~~~~~~~~~~~
  58 See:
  59
  60 - https://hub.docker.com/r/mangadl/manga-py/tags?page=1&ordering=last_updated
  61
  62
  63 Downloading manga
  64 -----------------
  65
  66 **:warning: For sites with cloudflare protect need installed Node.js**
  67
  68 **:warning: Notice! By default, the mode of multithreaded image loading is enabled**
  69
  70 **To change this behavior, add the key --no-multi-threads**
  71
  72 .. code:: bash
  73
  74     # download to "./Manga/<manga-name-here>" directory
  75     manga-py http://manga-url-here/manga-name
  76     # download to "./Manga/Manga Name" directory
  77     manga-py http://manga-url-here/manga-name --name 'Manga Name'
  78     # or download to /manga/destination/path/<manga-name-here> directory
  79     manga-py http://manga-url-here/manga-name -d /manga/destination/path/
  80     # skip 3 volumes
  81     manga-py --skip-volumes 3 http://manga-url-here/manga-name
  82     # skip 3 volumes and download 2 volumes
  83     manga-py --skip-volumes 3 --max-volumes 2 http://manga-url-here/manga-name
  84     # reverse volumes downloading (24 -> 1)
  85     manga-py --reverse-downloading http://manga-url-here/manga-name
  86     # Disable progressbar
  87     manga-py --no-progress http://manga-url-here/manga-name
  88
  89
  90 Embedded example:
  91 -----------------
  92 https://github.com/manga-py/manga-py/blob/stable_1.x/embedded.md
  93
  94 Help
  95 ----
  96
  97 .. code:: bash
  98
  99     manga-py -h
 100     # or
 101     manga-py --help
 102
 103 Suported by JetBrains
 104 ---------------------
 105 |JetBrains logo|
 106
 107
 108 Manga-py Docker
 109 ---------------
 110
 111 1. Install docker
 112
 113   - Summary https://docs.docker.com/install/
 114   - Mac https://docs.docker.com/docker-for-mac/install/
 115   - Windows https://docs.docker.com/docker-for-windows/install/
 116
 117
 118 2. Install manga-py
 119
 120 .. code:: bash
 121
 122     docker pull mangadl/manga-py
 123
 124
 125 3. Run it
 126
 127 .. code:: bash
 128
 129     docker run -it -v ${PWD}:/home/manga mangadl/manga-py
 130
 131
 132 For `manga-py >= 1.18`, the transfer of login / password / language / translation group has been added:
 133
 134 .. code:: bash
 135
 136     manga-py http://... --arguments language=en login=my-login "password=secured-#\!Password" "translator=Awesome group"
 137
 138
 139 .. |Travis CI result stable1.x| image:: https://travis-ci.com/manga-py/manga-py.svg?branch=stable_1.x
 140    :target: https://travis-ci.com/manga-py/manga-py/branches
 141    :alt: Latest push
 142 .. |Travis CI result| image:: https://travis-ci.com/manga-py/manga-py.svg?branch=1.29.5
 143    :target: https://travis-ci.com/manga-py/manga-py/branches
 144    :alt: Latest tag
 145 .. |Code Climate| image:: https://codeclimate.com/github/manga-py/manga-py/badges/gpa.svg
 146    :target: https://codeclimate.com/github/manga-py/manga-py
 147 .. |Issue Count| image:: https://codeclimate.com/github/manga-py/manga-py/badges/issue_count.svg
 148    :target: https://codeclimate.com/github/manga-py/manga-py
 149 .. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/manga-py.svg
 150    :target: https://pypi.org/project/manga-py/
 151 .. |Scrutinizer CI result| image:: https://scrutinizer-ci.com/g/manga-py/manga-py/badges/quality-score.png?b=stable_1.x
 152    :target: https://scrutinizer-ci.com/g/manga-py/manga-py
 153 .. |Scrutinizer CI coverage| image:: https://scrutinizer-ci.com/g/manga-py/manga-py/badges/coverage.png?b=stable_1.x
 154    :target: https://scrutinizer-ci.com/g/manga-py/manga-py
 155 .. |GitHub issues| image:: https://img.shields.io/github/issues/manga-py/manga-py.svg
 156    :target: https://github.com/manga-py/manga-py/issues
 157 .. |PyPi version| image:: https://badge.fury.io/py/manga-py.svg
 158    :alt: PyPI
 159    :target: https://pypi.org/project/manga-py/
 160 .. |JetBrains logo| image:: https://github.com/yuru-yuri/manga-py/raw/stable_1.x/.github/jetbrains.png
 161    :alt: JetBrains
 162    :target: https://www.jetbrains.com/?from=manga-py
 163 .. |MicroBadger Layers| image:: https://img.shields.io/microbadger/layers/mangadl/manga-py
 164    :alt: MicroBadger Layers
 165 .. |MicroBadger Size| image:: https://img.shields.io/microbadger/image-size/mangadl/manga-py
 166    :alt: MicroBadger Size
 167 .. |GitHub repo size| image:: https://img.shields.io/github/repo-size/manga-py/manga-py
 168    :alt: GitHub repo size
 169 .. |PyPI - Downloads| image:: https://img.shields.io/pypi/dm/manga-py
 170    :alt: PyPI - Downloads
 171 .. |PyPI - size| image:: https://img.shields.io/badge/dynamic/json?label=PyPI%20size&query=%24.size&url=https%3A%2F%2Fpip.sttv.me%2Fmanga-py.json%3Fhuman-size%3Dtrue%26index%3D0%26version%3D1.29.5
 172    :alt: PyPI - size