github/gallery-dl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] Fix inconsistency about which sites have optional authentication (#359)

Browse Source 
* [docs] Fix inconsistency about which sites have optional authentication

* update authentication docs
This commit is contained in:
Mark Henrick
2019-07-29 17:22:31 +01:00
committed by Mike Fährmann
parent 81b35ed3cb
commit 923e1bb714
4 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.rst
View File

@@ -168,10 +168,11 @@ Username & Password
------------------- -------------------
Some extractors require you to provide valid login-credentials in the form of Some extractors require you to provide valid login-credentials in the form of
a username & password pair. a username & password pair. This is necessary for
This is necessary for ``pixiv``, ``nijie`` and ``seiga`` ``pixiv``, ``nijie``, and ``seiga``
and optional (but strongly recommended) for ``exhentai``, ``luscious``, and optional (but strongly recommended) for
``sankaku``, ``idolcomplex``, ``tsumino`` and ``wallhaven``. ``danbooru``, ``exhentai``, ``idolcomplex``, ``instagram``,
``luscious``, ``sankaku``, ``tsumino``, and ``twitter``.
You can set the necessary information in your configuration file You can set the necessary information in your configuration file
(cf. gallery-dl.conf_) (cf. gallery-dl.conf_)

9
docs/configuration.rst
View File

@@ -164,10 +164,11 @@ Default ``null``
Description The username and password to use when attempting to log in to Description The username and password to use when attempting to log in to
another site. another site.
Specifying username and password is Specifying username and password is required for the
required for the ``pixiv``, ``nijie`` and ``seiga`` modules and ``pixiv``, ``nijie``, and ``seiga``
optional (but strongly recommended) for ``danbooru``, ``exhentai``, modules and optional (but strongly recommended) for
``sankaku`` and ``idolcomplex``. ``danbooru``, ``exhentai``, ``idolcomplex``, ``instagram``,
``luscious``, ``sankaku``, ``tsumino``, and ``twitter``.
These values can also be set via the ``-u/--username`` and These values can also be set via the ``-u/--username`` and
``-p/--password`` command-line options or by using a |.netrc|_ file. ``-p/--password`` command-line options or by using a |.netrc|_ file.

3
docs/supportedsites.rst
View File

@@ -108,7 +108,7 @@ Tsumino https://www.tsumino.com/ Galleries, Search Resul
Tumblr https://www.tumblr.com/ Images from Users, Likes, Posts, Tag-Searches Optional (OAuth) Tumblr https://www.tumblr.com/ Images from Users, Likes, Posts, Tag-Searches Optional (OAuth)
Twitter https://twitter.com/ Media Timelines, Timelines, Tweets Optional Twitter https://twitter.com/ Media Timelines, Timelines, Tweets Optional
VSCO https://vsco.co/ Images from Users, Collections, individual Images VSCO https://vsco.co/ Images from Users, Collections, individual Images
Wallhaven https://wallhaven.cc/ individual Images, Search Results Wallhaven https://wallhaven.cc/ individual Images, Search Results |wallhaven-A|
Warosu https://warosu.org/ Threads Warosu https://warosu.org/ Threads
Weibo https://www.weibo.com/ Images from Users, Images from Statuses Weibo https://www.weibo.com/ Images from Users, Images from Statuses
WikiArt.org https://www.wikiart.org/ Artists, Artworks WikiArt.org https://www.wikiart.org/ Artists, Artworks
@@ -139,4 +139,5 @@ Turboimagehost https://www.turboimagehost.com/ individual Images
.. |pixnet-C| replace:: Images from Users, Folders, individual Images, Sets .. |pixnet-C| replace:: Images from Users, Folders, individual Images, Sets
.. |pornreactor-C| replace:: Images from Users, Posts, Search Results, Tag-Searches .. |pornreactor-C| replace:: Images from Users, Posts, Search Results, Tag-Searches
.. |smugmug-C| replace:: Albums, individual Images, Images from Users and Folders .. |smugmug-C| replace:: Albums, individual Images, Images from Users and Folders
.. |wallhaven-A| replace:: Optional (`API Key <configuration.rst#extractorwallhavenapi-key>`__)
.. |yuki-S| replace:: yuki.la 4chan archive .. |yuki-S| replace:: yuki.la 4chan archive

2
scripts/supportedsites.py
View File

@@ -123,6 +123,8 @@ AUTH_MAP = {
"tsumino" : "Optional", "tsumino" : "Optional",
"tumblr" : "Optional (OAuth)", "tumblr" : "Optional (OAuth)",
"twitter" : "Optional", "twitter" : "Optional",
"wallhaven" : ("Optional (`API Key "
"<configuration.rst#extractorwallhavenapi-key>`__)"),
} }
IGNORE_LIST = ( IGNORE_LIST = (