gallery-dl

==========
gallery-dl
==========

*gallery-dl* is a command-line program
to download image galleries and collections
from several image hosting sites
(see `Supported Sites <docs/supportedsites.md>`__).
It is a cross-platform tool
with many
`command-line <https://gdl-org.github.io/docs/options.html>`__ and
`configuration <https://gdl-org.github.io/docs/configuration.html>`__
options, as well as powerful
`file-naming capabilities <https://gdl-org.github.io/docs/formatting.html>`__.

-----

Migration
=========

| Active development has moved to `Codeberg <https://codeberg.org/mikf/gallery-dl>`__
| (see `[Announcement] Moving to Codeberg <https://github.com/mikf/gallery-dl/issues/9374>`__ for details)

-----


.. contents::

|pypi| |discord| |build|


Dependencies
============

- Python_ 3.8+
- Requests_

Optional
--------

- yt-dlp_ or youtube-dl_: HLS/DASH video downloads, ``ytdl`` integration
- FFmpeg_: Pixiv Ugoira conversion
- mkvmerge_: Accurate Ugoira frame timecodes
- PySocks_: SOCKS proxy support
- brotli_ or brotlicffi_: Brotli compression support
- zstandard_: Zstandard compression support
- PyYAML_: YAML configuration file support
- toml_: TOML configuration file support for Python<3.11
- SecretStorage_: GNOME keyring passwords for ``--cookies-from-browser``
- Psycopg_: PostgreSQL archive support
- truststore_: Native system certificate support
- Jinja_: Jinja template support


Installation
============


Pip
---

The stable releases of *gallery-dl* are distributed on PyPI_ and can be
easily installed or upgraded using pip_:

.. code:: bash

    python -m pip install -U gallery-dl

Installing the latest dev version directly  from ``master``
can be done with pip_ as well:

.. code:: bash

    python -m pip install -U --force-reinstall --no-deps https://codeberg.org/mikf/gallery-dl/archive/master.tar.gz

Omit :code:`--no-deps` if Requests_ hasn't been installed yet.

Note: Windows users should use :code:`py` instead of :code:`python`.

It is advised to use the latest version of pip_,
including the essential packages :code:`setuptools` and :code:`wheel`.
To ensure these packages are up-to-date, run

.. code:: bash

    python -m pip install --upgrade pip setuptools wheel


Standalone Executable
---------------------

Prebuilt executable files with a Python interpreter and
required Python packages included are available for

- `Windows <https://codeberg.org/mikf/gallery-dl/releases/download/v1.32.19/gallery-dl.exe>`__
  (Requires `Microsoft Visual C++ Redistributable Package (x86) <https://aka.ms/vs/17/release/vc_redist.x86.exe>`__)
- `Linux   <https://codeberg.org/mikf/gallery-dl/releases/download/v1.32.19/gallery-dl.bin>`__


Nightly Builds
--------------

| Executables built from the latest commit can be found at
| https://github.com/gdl-org/builds/releases


Snap
----

Linux users that are using a distro that is supported by Snapd_ can install *gallery-dl* from the Snap Store:

.. code:: bash

    snap install gallery-dl


Chocolatey
---