1
0
mirror of https://github.com/mikf/gallery-dl.git synced 2024-11-22 18:53:21 +01:00
gallery-dl/README.rst

109 lines
2.6 KiB
ReStructuredText
Raw Normal View History

2015-11-03 22:08:19 +01:00
==========
gallery-dl
==========
2016-07-25 11:13:54 +02:00
*gallery-dl* is a small command-line tool to download images and entire image
2016-08-22 12:21:31 +02:00
galleries from several image hosting platforms. It requires Python 3.3+ to run
and works on Unix-like systems as well as Windows.
2016-07-25 11:13:54 +02:00
2015-11-03 22:08:19 +01:00
Installation
2015-11-10 21:13:43 +01:00
============
2015-11-03 22:08:19 +01:00
2015-11-10 21:13:43 +01:00
You can install *gallery-dl* with pip:
2015-11-03 22:08:19 +01:00
.. code:: bash
$ pip install gallery-dl
2015-11-10 21:13:43 +01:00
or directly from github:
2015-11-03 22:08:19 +01:00
.. code:: bash
$ git clone https://github.com/mikf/gallery-dl.git
$ cd gallery-dl
$ python3 setup.py install
2015-11-10 21:13:43 +01:00
2015-11-03 22:08:19 +01:00
Usage
2015-11-10 21:13:43 +01:00
=====
2015-11-03 22:08:19 +01:00
.. code:: bash
$ gallery-dl URL [URL...]
2016-07-25 11:13:54 +02:00
Supported Sites
===============
* Booru:
behoimi.org, danbooru.donmai.us, e621.net, gelbooru.com, konachan.com,
safebooru.org, chan.sankakucomplex.com, yande.re
* Manga:
bato.to, kissmanga.com, mangahere.co, mangamint.com, mangapanda.com,
mangapark.me, mangareader.net, mangashare.com, mangastream.com,
2016-08-03 17:09:15 +02:00
powermanga.org, raw.senmanga.com, thespectrum.net
2016-07-25 11:13:54 +02:00
* Hentai:
2016-08-05 09:48:34 +02:00
doujinmode.net, exhentai.org, hbrowse.com, hentai2read.com,
2016-08-06 13:24:40 +02:00
hentaibox.net, hitomi.la, luscious.net, nhentai.net
2016-07-25 11:13:54 +02:00
* Japanese:
2016-08-09 16:36:30 +02:00
pixiv.net, nijie.info, seiga.nicovideo.jp
2016-07-25 11:13:54 +02:00
* Western:
2016-08-09 14:05:12 +02:00
deviantart.com, hentai-foundry.com, imagefap,com, imgth.com, imgur.com,
2016-09-02 19:11:16 +02:00
pinterest.com, tumblr.com
2016-07-25 11:13:54 +02:00
* Futaba Channel-like:
4chan.org, 8ch.net
* Image Hosts:
2016-08-06 13:24:40 +02:00
chronos.to, imagebam.com, imagetwist.com, img.yt, imgbox.com, imgchili.net,
2016-07-25 11:13:54 +02:00
turboimagehost.com
2015-11-10 21:13:43 +01:00
2015-11-03 22:08:19 +01:00
Configuration
2015-11-10 21:13:43 +01:00
=============
2015-11-03 22:08:19 +01:00
2016-07-25 11:13:54 +02:00
Configuration files for gallery-dl use a JSON-based file format.
For a (more or less) complete example, see gallery-dl.conf_.
2015-11-03 22:08:19 +01:00
2015-11-10 21:13:43 +01:00
*gallery-dl* searches for configuration files in the following paths:
2015-11-03 22:08:19 +01:00
2016-07-25 11:13:54 +02:00
* ``/etc/gallery-dl.conf``
* ``~/.config/gallery-dl/config.json``
* ``~/.gallery-dl.conf``
2015-11-03 22:08:19 +01:00
Values in later configuration files will override previous ones.
2016-07-25 11:13:54 +02:00
Authentication
==============
Some extractors require you to provide valid login-credentials.
2016-08-09 16:36:30 +02:00
This currently includes ``pixiv``, ``exhentai``, ``nijie`` and ``seiga``.
2016-07-25 11:13:54 +02:00
You can set the necessary information in your configuration file
(cf. gallery-dl.conf_)
.. code::
{
"extractor": {
...
"pixiv:" {
"username": "<username>",
"password": "<password>"
}
...
}
}
or you can provide them directly via the
:code:`-u/--username` and :code:`-p/--password` or via the
:code:`-o/--option` command-line options
.. code:: bash
$ gallery-dl -u <username> -p <password> URL
$ gallery-dl -o username=<username> -o password=<password> URL
.. _gallery-dl.conf: https://github.com/mikf/gallery-dl/blob/master/gallery-dl.conf