You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gallery-dl/README.rst

107 lines
2.4 KiB

9 years ago
==========
gallery-dl
==========
8 years ago
*gallery-dl* is a small command-line tool to download images and entire image
galleries from several image hosting platforms.
9 years ago
Installation
9 years ago
============
9 years ago
9 years ago
You can install *gallery-dl* with pip:
9 years ago
.. code:: bash
$ pip install gallery-dl
9 years ago
or directly from github:
9 years ago
.. code:: bash
$ git clone https://github.com/mikf/gallery-dl.git
$ cd gallery-dl
$ python3 setup.py install
9 years ago
9 years ago
Usage
9 years ago
=====
9 years ago
.. code:: bash
$ gallery-dl URL [URL...]
8 years ago
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,
powermanga.org, raw.senmanga.com, thespectrum.net
8 years ago
* Hentai:
doujinmode.net, exhentai.org, hbrowse.com, hentai2read.com,
hentai-foundry.com, hitomi.la, luscious.net, nhentai.net
8 years ago
* Japanese:
pixiv.net, nijie.info
* Western:
deviantart.com, imgth.com, imgur.com, tumblr.com
* Futaba Channel-like:
4chan.org, 8ch.net
* Image Hosts:
chronos.to, imagebam.com, imagetwist.com, imgbox.com, imgchili.net, img.yt,
8 years ago
turboimagehost.com
9 years ago
9 years ago
Configuration
9 years ago
=============
9 years ago
8 years ago
Configuration files for gallery-dl use a JSON-based file format.
For a (more or less) complete example, see gallery-dl.conf_.
9 years ago
9 years ago
*gallery-dl* searches for configuration files in the following paths:
9 years ago
8 years ago
* ``/etc/gallery-dl.conf``
* ``~/.config/gallery-dl/config.json``
* ``~/.gallery-dl.conf``
9 years ago
Values in later configuration files will override previous ones.
8 years ago
Authentication
==============
Some extractors require you to provide valid login-credentials.
This currently includes ``pixiv``, ``exhentai`` and ``nijie``.
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