Minor documentation tweaks

- Instaloader as Cronjob sections

- Many new internal links to ease navigation
This commit is contained in:
Alexander Graf 2018-04-30 09:56:43 +02:00
parent 18ef484f3a
commit 1469064176
5 changed files with 54 additions and 6 deletions

View File

@ -3,6 +3,8 @@
Documentation of Instaloader module, a powerful and intuitive Documentation of Instaloader module, a powerful and intuitive
Python library to download Instagram media and metadata. Python library to download Instagram media and metadata.
.. _python-module-instaloader:
Python Module :mod:`instaloader` Python Module :mod:`instaloader`
-------------------------------- --------------------------------

View File

@ -5,6 +5,8 @@
and private profiles, hashtags, stories, feeds, saved media, and and private profiles, hashtags, stories, feeds, saved media, and
their metadata, comments and captions. their metadata, comments and captions.
.. _download-pictures-from-instagram:
Download Pictures from Instagram Download Pictures from Instagram
--------------------------------- ---------------------------------
@ -90,6 +92,9 @@ downloads the pictures and videos and their captions. You can specify
**download geotags** of each post and save them as **download geotags** of each post and save them as
Google Maps link, Google Maps link,
For a reference of all supported command line options, see
:ref:`command-line-options`.
.. _filename-specification: .. _filename-specification:
Filename Specification Filename Specification
@ -237,3 +242,32 @@ files. Say, you now also want to export the number of comments the Posts had
when they were downloaded:: when they were downloaded::
instaloader --post-metadata-txt="{likes} likes, {comments} comments." <target>/*.json.xz instaloader --post-metadata-txt="{likes} likes, {comments} comments." <target>/*.json.xz
.. _instaloader-as-cronjob:
Instaloader as Cronjob
^^^^^^^^^^^^^^^^^^^^^^
Instaloader is suitable for running as a cronjob to periodically update your
personal Instagram archive. The :option:`--quiet` option disables user
interactions and logging of non-error messages. To non-interactively use
Instaloader logged-in, create a session file, e.g. in your home directory::
instaloader --login=your_username --sessionfile=~/.instaloader-session
Then use the same parameters in your cronjob to load the session and download
the given targets::
instaloader --login=your_username --sessionfile=~/.instaloader-session --quiet <target> [...]
Without :option:`--sessionfile` option, Instaloader saves the session file in
a path within your temporary directory.
Programming Instaloader
^^^^^^^^^^^^^^^^^^^^^^^
If your task cannot be done with the command line interface of Instaloader,
consider taking a look at the :ref:`python-module-instaloader`.
Instaloader exposes its internally used methods and structures, making it a
powerful and intuitive Python API for Instagram, allowing to further customize
obtaining media and metadata.

View File

@ -1,3 +1,5 @@
.. _command-line-options:
Command Line Options Command Line Options
==================== ====================
@ -12,7 +14,9 @@ posts marked as saved).
Here we explain the additional options that can be given to Instaloader to Here we explain the additional options that can be given to Instaloader to
customize its behavior. To get a list of all flags, their abbreviations and customize its behavior. To get a list of all flags, their abbreviations and
their descriptions, you may also run ``instaloader --help``. their descriptions, you may also run ``instaloader --help``. For an
introduction on how to use Instaloader, see
:ref:`download-pictures-from-instagram`.
What to Download What to Download
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
@ -142,6 +146,10 @@ Instaloader to login.
Password for your Instagram account. Without this option, you'll be prompted 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. for your password interactively if there is not yet a valid session file.
.. warning:: Using :option:`--password` option is discouraged for security
reasons. Enter your password interactively when asked, or use the
sessionfile feature (:option:`--sessionfile` to customize path).
How to Download How to Download
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
@ -177,5 +185,5 @@ Miscellaneous Options
.. option:: --quiet, -q .. option:: --quiet, -q
Disable user interaction, i.e. do not print messages (except errors) and fail Disable user interaction, i.e. do not print messages (except errors) and fail
if login credentials are needed but not given. This makes Instaloader if login credentials are needed but not given.
**suitable as a cron job**. This is handy for running :ref:`instaloader-as-cronjob`.

View File

@ -21,6 +21,8 @@ With `Python <https://www.python.org/>`__ installed, do::
$ instaloader profile [profile ...] $ instaloader profile [profile ...]
See :ref:`install` for more options on how to install Instaloader.
**Instaloader** **Instaloader**
- downloads **public and private profiles, hashtags, user stories, - downloads **public and private profiles, hashtags, user stories,
@ -44,6 +46,8 @@ With `Python <https://www.python.org/>`__ installed, do::
profile | "#hashtag" | profile | "#hashtag" |
:stories | :feed | :saved :stories | :feed | :saved
See :ref:`download-pictures-from-instagram` for a detailed introduction on how
to use Instaloader to download pictures from Instagram.
Instaloader Documentation Instaloader Documentation
------------------------- -------------------------

View File

@ -33,7 +33,7 @@ Install Instaloader
- On **Windows 10**, you may download the standalone executable from the - On **Windows 10**, you may download the standalone executable from the
`current release page <https://github.com/instaloader/instaloader/releases/latest>`__. `current release page <https://github.com/instaloader/instaloader/releases/latest>`__.
To get the most current version of Instaloader from our - To get the most current version of Instaloader from our
`Git repository <https://github.com/instaloader/instaloader>`__:: `Git repository <https://github.com/instaloader/instaloader>`__::
pip3 install --upgrade git+https://github.com/instaloader/instaloader pip3 install --upgrade git+https://github.com/instaloader/instaloader