Minor documentation improvements
This commit is contained in:
parent
dd80ef484c
commit
dba74ab8d4
@ -10,6 +10,9 @@ Download Pictures from Instagram
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
Here we describe how to use Instaloader to download pictures from Instagram. If
|
||||
you do not have Instaloader installed yet, see :ref:`install`.
|
||||
|
||||
.. NOTE that Section "Basic Usage" is duplicated in README.rst.
|
||||
|
||||
Basic Usage
|
||||
|
@ -23,7 +23,7 @@ posts along with the pictures's captions and the current **profile picture**
|
||||
there. If an already-downloaded profile has been renamed, Instaloader
|
||||
automatically **finds it by its unique ID** and renames the folder likewise.
|
||||
|
||||
.. option:: --profile-pic-only
|
||||
.. option:: --profile-pic-only, -P
|
||||
|
||||
Only download profile picture.
|
||||
|
||||
@ -31,7 +31,7 @@ automatically **finds it by its unique ID** and renames the folder likewise.
|
||||
|
||||
Do not download profile picture.
|
||||
|
||||
.. option:: --no-videos
|
||||
.. option:: --no-videos, -V
|
||||
|
||||
Do not download videos.
|
||||
|
||||
@ -39,14 +39,14 @@ automatically **finds it by its unique ID** and renames the folder likewise.
|
||||
|
||||
Do not download thumbnails of videos.
|
||||
|
||||
.. option:: --geotags
|
||||
.. option:: --geotags, -G
|
||||
|
||||
**Download geotags** when available. Geotags are stored as a text file with
|
||||
the location's name and a Google Maps link. This requires an additional
|
||||
request to the Instagram server for each picture, which is why it is disabled
|
||||
by default.
|
||||
|
||||
.. option:: --comments
|
||||
.. option:: --comments, -C
|
||||
|
||||
Download and update comments for each post. This requires an additional
|
||||
request to the Instagram server for each post, which is why it is disabled by
|
||||
@ -65,7 +65,7 @@ automatically **finds it by its unique ID** and renames the folder likewise.
|
||||
Template to write in txt file for each StoryItem. See
|
||||
:ref:`metadata-text-files`.
|
||||
|
||||
.. option:: --stories
|
||||
.. option:: --stories, -s
|
||||
|
||||
Also **download stories** of each profile that is downloaded. Requires
|
||||
:option:`--login`.
|
||||
@ -107,13 +107,13 @@ When to Stop Downloading
|
||||
If none of these options are given, Instaloader goes through all pictures
|
||||
matching the specified targets.
|
||||
|
||||
.. option:: --fast-update
|
||||
.. option:: --fast-update, -F
|
||||
|
||||
For each target, stop when encountering the first already-downloaded picture.
|
||||
This flag is recommended when you use Instaloader to update your personal
|
||||
Instagram archive.
|
||||
|
||||
.. option:: --count COUNT
|
||||
.. option:: --count COUNT, -c
|
||||
|
||||
Do not attempt to download more than COUNT posts. Applies only to
|
||||
``#hashtag`` and ``:feed``.
|
||||
@ -127,17 +127,17 @@ profiles. To login, pass the :option:`--login` option. Your session cookie (not
|
||||
password!) will be saved to a local file to be reused next time you want
|
||||
Instaloader to login.
|
||||
|
||||
.. option:: --login YOUR-USERNAME
|
||||
.. option:: --login YOUR-USERNAME, -l YOUR-USERNAME
|
||||
|
||||
Login name (profile name) for your Instagram account.
|
||||
|
||||
.. option:: --sessionfile SESSIONFILE
|
||||
.. option:: --sessionfile SESSIONFILE, -f SESSIONFILE
|
||||
|
||||
Path for loading and storing session key file. Defaults to a path within
|
||||
your temporary directory, encoding your local username and your Instagram
|
||||
profile name.
|
||||
|
||||
.. option:: --password YOUR-PASSWORD
|
||||
.. option:: --password YOUR-PASSWORD, -p YOUR-PASSWORD
|
||||
|
||||
Password for your Instagram account. Without this option, you'll be prompted
|
||||
for your password interactively if there is not yet a valid session file.
|
||||
@ -174,7 +174,7 @@ How to Download
|
||||
Miscellaneous Options
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. option:: --quiet
|
||||
.. option:: --quiet, -q
|
||||
|
||||
Disable user interaction, i.e. do not print messages (except errors) and fail
|
||||
if login credentials are needed but not given. This makes Instaloader
|
||||
|
@ -1,28 +1,24 @@
|
||||
Installation
|
||||
============
|
||||
.. _install:
|
||||
|
||||
Install Instaloader
|
||||
===================
|
||||
|
||||
.. highlight:: none
|
||||
|
||||
Instaloader requires `Python <https://www.python.org/>`__, at least
|
||||
version 3.5. If you have `pip <https://pypi.python.org/pypi/pip>`__
|
||||
installed, you may install Instaloader using
|
||||
**To install Instaloader**,
|
||||
|
||||
::
|
||||
#. Ensure that you have `Python <https://www.python.org/>`__, at least
|
||||
version 3.5 and `pip <https://pypi.python.org/pypi/pip>`__
|
||||
installed
|
||||
|
||||
pip3 install instaloader
|
||||
#. Then, install Instaloader using::
|
||||
|
||||
Alternatively, to get the most current version of Instaloader from our
|
||||
`Git repository <https://github.com/instaloader/instaloader>`__:
|
||||
pip3 install instaloader
|
||||
|
||||
::
|
||||
**To upgrade Instaloader**, do::
|
||||
|
||||
pip3 install git+https://github.com/instaloader/instaloader
|
||||
pip3 install --upgrade instaloader
|
||||
|
||||
(pass ``--upgrade`` to upgrade if Instaloader is already installed)
|
||||
|
||||
Instaloader requires
|
||||
`requests <http://python-requests.org/>`__, which
|
||||
will be installed automatically, if it is not already installed.
|
||||
|
||||
**Alternative methods for installing Instaloader:**
|
||||
|
||||
@ -34,8 +30,10 @@ will be installed automatically, if it is not already installed.
|
||||
- On **Arch Linux**, you may install Instaloader using the
|
||||
`Instaloader AUR package <https://aur.archlinux.org/packages/instaloader/>`__.
|
||||
|
||||
- On **Gentoo Linux**, you may install Instaloader using the
|
||||
`Instaloader Ebuild <https://bugs.gentoo.org/642100>`__.
|
||||
|
||||
- On **Windows 10**, you may download the standalone executable from the
|
||||
`current release page <https://github.com/instaloader/instaloader/releases/latest>`__.
|
||||
|
||||
To get the most current version of Instaloader from our
|
||||
`Git repository <https://github.com/instaloader/instaloader>`__::
|
||||
|
||||
pip3 install --upgrade git+https://github.com/instaloader/instaloader
|
||||
|
Loading…
Reference in New Issue
Block a user