update README.rst

- add table of contents
- update "Standalone Executable" section
- mention OAuth for Mastodon instances
pull/1352/head
Mike Fährmann 4 years ago
parent ffce8d85e7
commit 511fadf313
No known key found for this signature in database
GPG Key ID: 5680CA389D365A88

@ -10,6 +10,8 @@ and powerful filenaming capabilities.
|pypi| |build| |gitter| |pypi| |build| |gitter|
.. contents::
Dependencies Dependencies
============ ============
@ -47,9 +49,9 @@ pip_ as well:
Note: Windows users should use :code:`py -3` instead of :code:`python3`. Note: Windows users should use :code:`py -3` instead of :code:`python3`.
| It is advised to use the latest version of pip_, It is advised to use the latest version of pip_,
including the essential packages :code:`setuptools` and :code:`wheel`. including the essential packages :code:`setuptools` and :code:`wheel`.
| To ensure that these packages are up-to-date, run To ensure these packages are up-to-date, run
.. code:: bash .. code:: bash
@ -59,15 +61,14 @@ Note: Windows users should use :code:`py -3` instead of :code:`python3`.
Standalone Executable Standalone Executable
--------------------- ---------------------
Download a standalone executable file, Prebuilt executable files with a Python interpreter and
put it into your `PATH <https://en.wikipedia.org/wiki/PATH_(variable)>`__, required Python packages included are available for
and run it inside a command prompt (like ``cmd.exe``).
- `Windows <https://github.com/mikf/gallery-dl/releases/download/v1.16.5/gallery-dl.exe>`__ - `Windows <https://github.com/mikf/gallery-dl/releases/download/v1.16.5/gallery-dl.exe>`__
- `Linux <https://github.com/mikf/gallery-dl/releases/download/v1.16.5/gallery-dl.bin>`__ - `Linux <https://github.com/mikf/gallery-dl/releases/download/v1.16.5/gallery-dl.bin>`__
These executables include a Python interpreter | Executables build from the latest commit can be found at
and all required Python packages. | https://github.com/mikf/gallery-dl/actions/workflows/executables.yml
Snap Snap
@ -236,6 +237,7 @@ or you can provide them directly via the
$ gallery-dl -u <username> -p <password> URL $ gallery-dl -u <username> -p <password> URL
$ gallery-dl -o username=<username> -o password=<password> URL $ gallery-dl -o username=<username> -o password=<password> URL
Cookies Cookies
------- -------
@ -279,12 +281,14 @@ the :code:`--cookies` command-line option:
$ gallery-dl --cookies "$HOME/path/to/cookies.txt" URL $ gallery-dl --cookies "$HOME/path/to/cookies.txt" URL
OAuth OAuth
----- -----
*gallery-dl* supports user authentication via OAuth_ for *gallery-dl* supports user authentication via OAuth_ for
``deviantart``, ``flickr``, ``reddit``, ``smugmug`` and ``tumblr``. ``deviantart``, ``flickr``, ``reddit``, ``smugmug``, ``tumblr``,
This is entirely optional, but grants *gallery-dl* the ability and ``mastodon`` instances.
This is mostly optional, but grants *gallery-dl* the ability
to issue requests on your account's behalf and enables it to access resources to issue requests on your account's behalf and enables it to access resources
which would otherwise be unavailable to a public user. which would otherwise be unavailable to a public user.
@ -299,13 +303,20 @@ You will be sent to the site's authorization page and asked to grant read
access to *gallery-dl*. Authorize it and you will be shown one or more access to *gallery-dl*. Authorize it and you will be shown one or more
"tokens", which should be added to your configuration file. "tokens", which should be added to your configuration file.
To authenticate with a ``mastodon`` instance, run *gallery-dl* with
``oauth:mastodon:<instance>`` as argument. For example:
.. code:: bash
$ gallery-dl oauth:mastodon:pawoo.net
$ gallery-dl oauth:mastodon:https://mastodon.social/
.. _gallery-dl.conf: https://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl.conf .. _gallery-dl.conf: https://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl.conf
.. _gallery-dl-example.conf: https://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl-example.conf .. _gallery-dl-example.conf: https://github.com/mikf/gallery-dl/blob/master/docs/gallery-dl-example.conf
.. _configuration.rst: https://github.com/mikf/gallery-dl/blob/master/docs/configuration.rst .. _configuration.rst: https://github.com/mikf/gallery-dl/blob/master/docs/configuration.rst
.. _Supported Sites: https://github.com/mikf/gallery-dl/blob/master/docs/supportedsites.rst .. _Supported Sites: https://github.com/mikf/gallery-dl/blob/master/docs/supportedsites.rst
.. _stable: https://github.com/mikf/gallery-dl/archive/v1.16.5.tar.gz
.. _dev: https://github.com/mikf/gallery-dl/archive/master.tar.gz
.. _Python: https://www.python.org/downloads/ .. _Python: https://www.python.org/downloads/
.. _PyPI: https://pypi.org/ .. _PyPI: https://pypi.org/

Loading…
Cancel
Save