1 gallery-dl

gallery-dl is a command-line program to download image-galleries and -collections from several image hosting sites such as pixiv.net, exhentai.org, gelbooru.com and several more (see Supported Sites). It requires Python 3.3+ to run and works on Unix-like systems as well as on Windows.

1.1 Installation

1.1.1 Installation via pip

The stable releases of gallery-dl are distributed on PyPI and can be easily installed using pip:

$ pip install gallery-dl

Installing the latest dev-version directly from GitHub can be done via pip as well:

$ pip install https://github.com/mikf/gallery-dl/archive/master.zip

1.1.2 Manual installation via Python

You can also install gallery-dl manually:

Get the code by either

Downloading a stable or dev archive and unpacking it
Or via git clone

Navigate into the respective directory and run the setup.py file.

$ wget https://github.com/mikf/gallery-dl/archive/master.zip
$ unzip master.zip
# or
$ git clone https://github.com/mikf/gallery-dl.git

$ cd gallery-dl
$ python setup.py install

1.1.3 Standalone executable (Windows only)

Windows users can download a standalone executable, which comes with a Python interpreter and all required packages included.

Put this file in your PATH or use it from the current directory and you are good to go,

1.2 Usage

To use gallery-dl simply call it with the URLs you wish to download images from:

$ gallery-dl [OPTION]... URL...

1.2.1 Examples

Download images; in this case from gelbooru via tag search for ‘bonocho’:

$ gallery-dl "http://gelbooru.com/index.php?page=post&s=list&tags=bonocho"

Get the direct URL of an image from a site that requires authentication:

$ gallery-dl -g -u <username> -p <password> http://seiga.nicovideo.jp/seiga/im3211703

Search a remote resource for URLs and download images from them:

(URLs for which no extractor can be found will be silently ignored)

$ gallery-dl r:https://pastebin.com/raw/FLwrCYsT

1.4 Configuration

Configuration files for gallery-dl use a JSON-based file format. For a (more or less) complete example, see gallery-dl.conf. A list of all available configuration options and their descriptions can be found in configuration.rst.

gallery-dl searches for configuration files in the following paths:

Linux	Windows
/etc/gallery-dl.conf ${HOME}/.config/gallery-dl/config.json ${HOME}/.gallery-dl.conf	%USERPROFILE%\gallery-dl\config.json %USERPROFILE%\gallery-dl.conf

(%USERPROFILE% usually refers to the users home directory, i.e. C:\Users\<username>\)

Values in later configuration files will override previous ones.

1.5 Authentication

1.5.1 Username & Password

Some extractors require you to provide valid login-credentials in the form of a username & password pair. This is necessary for pixiv, nijie and seiga and optional (but strongly recommended) for exhentai and batoto.

You can set the necessary information in your configuration file (cf. gallery-dl.conf)

{
    "extractor": {
        ...
        "pixiv": {
            "username": "<username>",
            "password": "<password>"
        }
        ...
    }
}

or you can provide them directly via the -u/--username and -p/--password or via the -o/--option command-line options

$ gallery-dl -u <username> -p <password> URL
$ gallery-dl -o username=<username> -o password=<password> URL

1.5.2 OAuth

gallery-dl supports user authentication via OAuth for flickr and reddit. This is entirely optional, but grants gallery-dl the ability to issue requests on your account’s behalf and enables it to access resources which would otherwise be unavailable to a public user.

To link your account to gallery-dl, start by invoking it with oauth:<site-name> as an argument. For example:

$ gallery-dl oauth:flickr

You will be sent to the site’s authorization page and asked to grant read access to gallery-dl. Authorize it and you will he shown one or more “tokens”, which should be added to your configuration file.

Metadata

Release files for gallery-dl 0.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gallery-dl 0.9.1
File	Size	Uploaded	Provenance
gallery_dl-0.9.1.tar.gz	94.3 kB	Jul 24, 2017	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for gallery-dl 0.9.1
File	Interpreter	ABI	Platform	Reset
gallery_dl-0.9.1-py3-none-any.whl 154.7 kB Jul 24, 2017 Without provenance	Python 3	none	any	Details

Total release size: 249.0 kB

Release files / gallery_dl-0.9.1.tar.gz

Download URL	gallery_dl-0.9.1.tar.gz
Size	94.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`08d3da69fb4bc945dabe53b212476a51d576b1ec4c58f78c7e32831533f06227`
BLAKE2b-256 checksum How to use checksums	`833a5a32c497637ed52cb4b142027e2a99f2051b04326641c66e44a9a4f2e5a0`
Upload date	Jul 24, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Release files / gallery_dl-0.9.1-py3-none-any.whl

Download URL	gallery_dl-0.9.1-py3-none-any.whl
Size	154.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9cf91744b43cadb10031419e3976e67319ae988868552145fed790c39342a184`
BLAKE2b-256 checksum How to use checksums	`eab6e2090b146913638dc5fb8b26842063b4f409b3d9fef49b447a53c38edc81`
Upload date	Jul 24, 2017
Uploaded using Trusted Publishing? What is trusted publishing?	No

Security for gallery-dl 0.9.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.