Download pictures (or videos) along with their captions and other metadata from Instagram.
diff --git a/docs/as-module.rst b/docs/as-module.rst index 6cd831b..e047434 100644 --- a/docs/as-module.rst +++ b/docs/as-module.rst @@ -5,68 +5,65 @@ Python Module :mod:`instaloader` .. highlight:: python -You may also use parts of Instaloader as library to do other interesting -things. +Instaloader exposes its internally used methods as a Python module, making it a +**powerful and easy-to-use Python API for Instagram**, allowing to further +customize obtaining media and metadata. -For example, to get a list of all followees and a list of all followers of a profile, do - -.. code:: python +Start with getting an instance of :class:`Instaloader`:: import instaloader # Get instance - loader = instaloader.Instaloader() + L = instaloader.Instaloader() - # Login - loader.interactive_login(USERNAME) + # Optionally, login or load session + L.login(USER, PASSWORD) # (login) + L.interactive_login(USER) # (ask password on terminal) + L.load_session_from_file(USER) # (load session created w/ + # `instaloader -l USERNAME`) + +:mod:`instaloader` provides the :class:`Post` structure, which represents a +picture, video or sidecar (set of multiple pictures/videos) posted in a user's +profile. :class:`Instaloader` provides methods to iterate over Posts from a +certain source:: + + for post in L.get_hashtag_posts('cat'): + # post is an instance of instaloader.Post + L.download_post(post, target='#cat') + +Besides :func:`Instaloader.get_hashtag_posts`, there is +:func:`Instaloader.get_feed_posts` and :func:`Instaloader.get_profile_posts`. +Also, :class:`Post` instances can be created with :func:`Post.from_shortcode` +and :func:`Post.from_mediaid`. + +Further, information about profiles can be easily obtained. For example, you may +print a list of all followees and followers of a profile with:: # Print followees print(PROFILE + " follows these profiles:") - for f in loader.get_followees(PROFILE): + for f in L.get_followees(PROFILE): print("\t%s\t%s" % (f['username'], f['full_name'])) # Print followers print("Followers of " + PROFILE + ":") - for f in loader.get_followers(PROFILE): + for f in L.get_followers(PROFILE): print("\t%s\t%s" % (f['username'], f['full_name'])) -Then, you may download all pictures of all followees with +Then, you may download all pictures of all followees with:: -.. code:: python + for f in L.get_followees(PROFILE): + L.download_profile(f['username']) - for f in loader.get_followees(PROFILE): - loader.download_profile(f['username']) +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:: -You could also download your last 20 liked pics with - -.. code:: python - - loader.download_feed_posts(max_count=20, fast_update=True, - filter_func=lambda post: post.viewer_has_liked) - -To download the last 20 pictures with hashtag #cat, do - -.. code:: python - - loader.download_hashtag('cat', max_count=20) - -Generally, :class:`Instaloader` provides methods to iterate over the Posts from -a certain source. - -.. code:: python - - for post in loader.get_hashtag_posts('cat'): - # post is an instance of instaloader.Post - loader.download_post(post, target='#cat') - -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 - -.. code:: python - - loader.get_id_by_username(PROFILE_NAME) + L.get_id_by_username(PROFILE_NAME) +A reference of the many methods provided by the :mod:`instaloader` module is +provided in the remainder of this document. Feel free to direct any issue or +contribution to +`Instaloader on Github