Release of version 2.2

Concerns issue #26.

.travis.yml

@@ -9,4 +9,4 @@ python:
 install:
  - pip install pylint requests
 script:
- - python3 -m pylint -r n -d bad-whitespace,missing-docstring,too-many-arguments,locally-disabled,line-too-long,too-many-public-methods,too-many-lines instaloader
+ - python3 -m pylint -r n -d bad-whitespace,missing-docstring,too-many-arguments,locally-disabled,line-too-long,too-many-public-methods,too-many-lines,too-many-instance-attributes,too-many-locals,too-many-branches,too-many-statements instaloader

README.rst

@@ -1,7 +1,7 @@
 Instaloader
 ===========
 
-Tool to automatically download pictures (or videos) of given profiles
+Download pictures (or videos) along with their captions and other metadata
 from Instagram.
 
 Installation
@@ -68,6 +68,13 @@ in your temporary directory, which will be reused later when ``--login`` is give
 you can download private profiles **non-interactively** when you already
 have a valid session cookie file.
 
+Besides downloading private profiles, being logged in allows to
+**download stories**:
+
+::
+
+    instaloader --login=your_username --stories profile [profile ...]
+
 You may also download
 **the most recent pictures by hashtag**:
 
@@ -75,6 +82,15 @@ You may also download
 
     instaloader "#hashtag"
 
+This downloads the requested posts into a directory named according to the specified
+hashtag and the filenames correspond to the timestamp of the posts.
+As with all download tasks, this behavior can easily be customized, for example
+encode the poster's profile name in the filenames:
+
+::
+
+    instaloader --filename-pattern={date}_{profile} "#hashtag"
+
 If you want to **download all followees of a given profile**, call
 
 ::
@@ -93,6 +109,12 @@ or to **download all pictures from your feed**:
 
     instaloader --login=your_username :feed-all
 
+**Download all stories** from the profiles you follow:
+
+::
+
+    instaloader --login=your_username --filename-pattern={date}_{profile} :stories
+
 Advanced Options
 ----------------
 
@@ -111,6 +133,11 @@ captions and the current **profile picture**. If an already-downloaded profile
 has been renamed, Instaloader automatically **finds it by its unique ID** and
 renames the folder likewise.
 
+Instead of a *profile* or a *#hashtag*, the special targets
+``:feed-all`` (pictures from your feed),
+``:feed-liked`` (pictures from your feed which you liked), and
+``:stories`` (stories of your followees) can be specified.
+
 --profile-pic-only         Only download profile picture.
 --skip-videos              Do not download videos.
 --geotags                  **Download geotags** when available. Geotags are stored as
@@ -121,6 +148,11 @@ renames the folder likewise.
 --comments                 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 default.
+--stories                  Also **download stories** of each profile that is
+                           downloaded. Requires ``--login``.
+--stories-only             Rather than downloading regular posts of each
+                           specified profile, only download stories.
+                           Requires ``--login``.
 
 When to Stop Downloading
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -157,15 +189,19 @@ Instaloader to login.
 How to Download
 ^^^^^^^^^^^^^^^
 
---no-profile-subdir        Instead of creating a subdirectory for each profile
-                           and storing pictures there, store pictures in files
-                           named ``PROFILE__DATE_TIME.jpg``.
---hashtag-username         Lookup username of pictures when downloading by
-                           #hashtag and encode it in the downlaoded file's path
-                           or filename (if ``--no-profile-subdir``). Without this
-                           option, the #hashtag is used instead. This requires an
-                           additional request to the Instagram server for each
-                           picture, which is why it is disabled by default.
+--dirname-pattern DIRNAME_PATTERN
+                           Name of directory where to store posts. ``{profile}``
+                           is replaced by the profile name, ``{target}`` is replaced
+                           by the target you specified, i.e. either ``:feed``,
+                           ``#hashtag`` or the profile name. Defaults to ``{target}``.
+--filename-pattern FILENAME_PATTERN
+                           Prefix of filenames. Posts are stored in the
+                           directory whose pattern is given with ``--dirname-pattern``.
+                           ``{profile}`` is replaced by the profile name,
+                           ``{target}`` is replaced by the target you specified, i.e.
+                           either ``:feed``, ``#hashtag`` or the profile name. Also, the
+                           fields ``{date}`` and ``{shortcode}`` can be specified.
+                           Defaults to ``{date:%Y-%m-%d_%H-%M-%S}``.
 --user-agent USER_AGENT    User Agent to use for HTTP requests. Per default,
                            Instaloader pretends being Chrome/51.
 --no-sleep                 Do not sleep between requests to Instagram's servers.
@@ -224,7 +260,7 @@ You could also download your last 20 liked pics with
 
 .. code:: python
 
-    oader.download_feed_pics(max_count=20, fast_update=True,
+    loader.download_feed_pics(max_count=20, fast_update=True,
                              filter_func=lambda node:
                                    not node["likes"]["viewer_has_liked"] if "likes" in node else not node["viewer_has_liked"])
 
@@ -234,6 +270,12 @@ To download the last 20 pictures with hashtag #cat, do
 
     loader.download_hashtag('cat', max_count=20)
 
+If logged in, Instaloader is also able to download user stories:
+
+.. code:: python
+
+    loader.download_stories()
+
 Each Instagram profile has its own unique ID which stays unmodified even
 if a user changes his/her username. To get said ID, given the profile's
 name, you may call
@@ -249,3 +291,9 @@ get the current username of a profile, given this unique ID
 .. code:: python
 
     loader.get_username_by_id(followees[0]['id'])
+
+Disclaimer
+----------
+
+This code is in no way affiliated with, authorized, maintained or endorsed by Instagram or any of its affiliates or
+subsidiaries. This is an independent and unofficial project. Use at your own risk.

setup.py

@@ -8,15 +8,14 @@ if sys.version_info < (3, 5):
 
 setup(
     name='instaloader',
-    version='2.0',
+    version='2.2',
     py_modules=['instaloader'],
     url='https://github.com/Thammus/instaloader',
     license='MIT',
     author='Alexander Graf, André Koch-Kramer',
     author_email='mail@agraf.me, koch-kramer@web.de',
-    description='Tool to download Instagram pictures (or videos) and captions from a given set of '
-                'profiles (even if private), from your feed or from all followees of a given '
-                'profile.',
+    description='Download pictures (or videos) along with their captions and other metadata '
+                'from Instagram.',
     long_description=open('README.rst').read(),
     install_requires=['requests>=2.4'],
     python_requires='>=3.5',