Release of version 2.0

Close #5

.travis.yml

@@ -9,4 +9,4 @@ python:
 install:
  - pip install pylint requests
 script:
- - python3 -m pylint -r n -d bad-whitespace,bad-continuation,missing-docstring,multiple-imports,too-many-arguments,locally-disabled,line-too-long,invalid-sequence-index 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 instaloader

README.rst

@@ -1,6 +1,8 @@
 Instaloader
 ===========
 
+Tool to automatically download pictures (or videos) of given profiles
+from Instagram.
 
 Installation
 ------------
@@ -26,6 +28,8 @@ Alternatively, to get the most current version of Instaloader from our
 
     pip3 install git+https://github.com/Thammus/instaloader
 
+(pass ``--upgrade`` to upgrade if Instaloader is already installed)
+
 Instaloader requires
 `requests <https://pypi.python.org/pypi/requests>`__, which
 will be installed automatically, if it is not already installed.
@@ -33,7 +37,8 @@ will be installed automatically, if it is not already installed.
 How to automatically download pictures from Instagram
 -----------------------------------------------------
 
-To download a set of profiles, do
+To **download all pictures and videos of a profile**, as well as the
+**profile picture**, do
 
 ::
 
@@ -42,13 +47,13 @@ To download a set of profiles, do
 where ``profile`` is the name of a profile you want to download. Instead
 of only one profile, you may also specify a list of profiles.
 
-To later update your local copy of that profile, you may run
+To later **update your local copy** of that profiles, you may run
 
 ::
 
     instaloader --fast-update profile [profile ...]
 
-When ``--fast-update`` is given, Instaloader terminates when arriving at
+When ``--fast-update`` is given, Instaloader stops when arriving at
 the first already-downloaded picture.
 
 Instaloader can also be used to **download private profiles**. To do so,
@@ -59,10 +64,17 @@ invoke it with
     instaloader --login=your_username profile [profile ...]
 
 When invoked like this, it also **stores the session cookies** in a file
-in ``/tmp``, which will be reused later when ``--login`` is given. So
+in your temporary directory, which will be reused later when ``--login`` is given. So
 you can download private profiles **non-interactively** when you already
 have a valid session cookie file.
 
+You may also download
+**the most recent pictures by hashtag**:
+
+::
+
+    instaloader "#hashtag"
+
 If you want to **download all followees of a given profile**, call
 
 ::
@@ -75,30 +87,128 @@ To **download all the pictures from your feed which you have liked**, call
 
     instaloader --login=your_username :feed-liked
 
-The ``--quiet`` option makes it also **suitable as a cron job**.
+or to **download all pictures from your feed**:
 
-To get a list of other helpful flags, run ``instaloader --help``.
+::
 
-Usage as library
+    instaloader --login=your_username :feed-all
+
+Advanced Options
 ----------------
 
+The following flags can be given to Instaloader to specify how profiles should
+be downloaded.
+
+To get a list of all flags, their abbreviations and their descriptions, you may
+run ``instaloader --help``.
+
+What to Download
+^^^^^^^^^^^^^^^^
+
+Specify a list of profiles or #hashtags. For each of these, Instaloader
+creates a folder and downloads all posts along with the pictures's
+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.
+
+--profile-pic-only         Only download profile picture.
+--skip-videos              Do not download videos.
+--geotags                  **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.
+--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.
+
+When to Stop Downloading
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+If none of these options are given, Instaloader goes through all pictures
+matching the specified targets.
+
+--fast-update              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.
+--count COUNT              Do not attempt to download more than COUNT posts.
+                           Applies only to ``#hashtag``, ``:feed-all`` and ``:feed-liked``.
+
+
+Login (Download Private Profiles)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Instaloader can **login to Instagram**. This allows downloading private
+profiles. To login, pass the ``--login`` option. Your session cookie (not your
+password!) will be saved to a local file to be reused next time you want
+Instaloader to login.
+
+--login YOUR-USERNAME      Login name (profile name) for your Instagram account.
+--sessionfile 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.
+--password 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.
+
+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.
+--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.
+                           This makes downloading faster, but may be suspicious.
+
+Miscellaneous Options
+^^^^^^^^^^^^^^^^^^^^^
+
+--shorter-output           Do not display captions while downloading.
+--quiet                    Disable user interaction, i.e. do not print messages
+                           (except errors) and fail if login credentials are
+                           needed but not given. This makes Instaloader
+                           **suitable as a cron job**.
+
+Usage as Python module
+----------------------
+
 You may also use parts of Instaloader as library to do other interesting
 things.
 
-For example, to get a list of all followers of a profile as well as
-their follower count, do
+For example, to get a list of all followees and a list of all followers of a profile, do
 
 .. code:: python
 
     import instaloader
 
-    # login
-    session = instaloader.get_logged_in_session(USERNAME)
+    # Get instance
+    loader = instaloader.Instaloader()
 
-    # get followees
-    followees = instaloader.get_followees(PROFILE, session)
+    # Login
+    loader.interactive_login(USERNAME)
+
+    # Retrieve followees
+    followees = loader.get_followees(PROFILE)
+    print(PROFILE + " follows these profiles:")
     for f in followees:
-        print("%i\t%s\t%s" % (f['follower_count'], f['username'], f['full_name']))
+        print("\t%s\t%s" % (f['username'], f['full_name']))
+
+    # Retrieve followers
+    followers = loader.get_followers(PROFILE)
+    print("Followers of " + PROFILE + ":")
+    for f in followers:
+        print("\t%s\t%s" % (f['username'], f['full_name']))
 
 Then, you may download all pictures of all followees with
 
@@ -106,7 +216,7 @@ Then, you may download all pictures of all followees with
 
     for f in followees:
         try:
-            instaloader.download(f['username'], session)
+            loader.download(f['username'])
         except instaloader.NonfatalException:
             pass
 
@@ -114,8 +224,15 @@ You could also download your last 20 liked pics with
 
 .. code:: python
 
-    instaloader.download_feed_pics(session, max_count=20, fast_update=True,
-                                   filter_func=lambda node: not node["likes"]["viewer_has_liked"])
+    oader.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"])
+
+To download the last 20 pictures with hashtag #cat, do
+
+.. code:: python
+
+    loader.download_hashtag('cat', max_count=20)
 
 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
@@ -123,7 +240,7 @@ name, you may call
 
 .. code:: python
 
-    instaloader.get_id_by_username(PROFILE_NAME)
+    loader.get_id_by_username(PROFILE_NAME)
 
 ``get_followees()`` also returns unique IDs for all loaded followees. To
 get the current username of a profile, given this unique ID
@@ -131,4 +248,4 @@ get the current username of a profile, given this unique ID
 
 .. code:: python
 
-    instaloader.get_username_by_id(session, followees[0]['id'])
+    loader.get_username_by_id(followees[0]['id'])

setup.py

@@ -8,7 +8,7 @@ if sys.version_info < (3, 5):
 
 setup(
     name='instaloader',
-    version='1.2.2',
+    version='2.0',
     py_modules=['instaloader'],
     url='https://github.com/Thammus/instaloader',
     license='MIT',