update README.rst and setup.py

- remove superfluous '-'s
- use definition list for config paths
- add Python 3.9 support to setup.py classifiers
pull/1195/head
Mike Fährmann 4 years ago
parent b8f2e42f7a
commit 1e59aa6123
No known key found for this signature in database
GPG Key ID: 5680CA389D365A88

@ -2,8 +2,8 @@
gallery-dl gallery-dl
========== ==========
*gallery-dl* is a command-line program to download image-galleries and *gallery-dl* is a command-line program to download image galleries and
-collections from several image hosting sites (see `Supported Sites`_). collections from several image hosting sites (see `Supported Sites`_).
It is a cross-platform tool with many configuration options It is a cross-platform tool with many configuration options
and powerful filenaming capabilities. and powerful filenaming capabilities.
@ -37,7 +37,7 @@ easily installed or upgraded using pip_:
$ python3 -m pip install -U gallery-dl $ python3 -m pip install -U gallery-dl
Installing the latest dev-version directly from GitHub can be done with Installing the latest dev version directly from GitHub can be done with
pip_ as well: pip_ as well:
.. code:: bash .. code:: bash
@ -86,7 +86,7 @@ and run it inside a command prompt (like ``cmd.exe``).
- `Windows <https://github.com/mikf/gallery-dl/releases/download/v1.15.4/gallery-dl.exe>`__ - `Windows <https://github.com/mikf/gallery-dl/releases/download/v1.15.4/gallery-dl.exe>`__
- `Linux <https://github.com/mikf/gallery-dl/releases/download/v1.15.4/gallery-dl.bin>`__ - `Linux <https://github.com/mikf/gallery-dl/releases/download/v1.15.4/gallery-dl.bin>`__
These executables include a Python 3.8 interpreter These executables include a Python interpreter
and all required Python packages. and all required Python packages.
@ -181,19 +181,22 @@ Configuration files for *gallery-dl* use a JSON-based file format.
see gallery-dl-example.conf_. see gallery-dl-example.conf_.
| A list of all available configuration options and their | A list of all available configuration options and their
descriptions can be found in configuration.rst_. descriptions can be found in configuration.rst_.
|
*gallery-dl* searches for configuration files in the following places: *gallery-dl* searches for configuration files in the following places:
+--------------------------------------------+------------------------------------------+ Windows:
| Linux | Windows | * ``%APPDATA%\gallery-dl\config.json``
+--------------------------------------------+------------------------------------------+ * ``%USERPROFILE%\gallery-dl\config.json``
|* ``/etc/gallery-dl.conf`` |* ``%APPDATA%\gallery-dl\config.json`` | * ``%USERPROFILE%\gallery-dl.conf``
|* ``${HOME}/.config/gallery-dl/config.json``|* ``%USERPROFILE%\gallery-dl\config.json``|
|* ``${HOME}/.gallery-dl.conf`` |* ``%USERPROFILE%\gallery-dl.conf`` |
+--------------------------------------------+------------------------------------------+
(``%USERPROFILE%`` usually refers to the user's home directory, (``%USERPROFILE%`` usually refers to the user's home directory,
i.e. ``C:\Users\<username>\``) i.e. ``C:\Users\<username>\``)
Linux, macOS, etc.:
* ``/etc/gallery-dl.conf``
* ``${HOME}/.config/gallery-dl/config.json``
* ``${HOME}/.gallery-dl.conf``
Values in later configuration files will override previous ones. Values in later configuration files will override previous ones.

@ -47,8 +47,8 @@ FILES = [
setup( setup(
name="gallery_dl", name="gallery_dl",
version=VERSION, version=VERSION,
description=("Command-line program to download image-galleries and " description=("Command-line program to download image galleries and "
"-collections from several image hosting sites"), "collections from several image hosting sites"),
long_description=read("README.rst"), long_description=read("README.rst"),
url="https://github.com/mikf/gallery-dl", url="https://github.com/mikf/gallery-dl",
download_url="https://github.com/mikf/gallery-dl/releases/latest", download_url="https://github.com/mikf/gallery-dl/releases/latest",
@ -92,6 +92,7 @@ setup(
"Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3 :: Only",
"Topic :: Internet :: WWW/HTTP", "Topic :: Internet :: WWW/HTTP",
"Topic :: Multimedia :: Graphics", "Topic :: Multimedia :: Graphics",

Loading…
Cancel
Save