Mirrors/instaloader
1
0
Fork 0
mirror of https://github.com/instaloader/instaloader.git synced 2024-11-04 09:22:29 +01:00
Code Issues Releases Activity
34416298a0
instaloader/README.rst

99 lines
3.1 KiB
ReStructuredText
Raw Normal View History

Add awesome logo to README Due to rst limitations, the heading "Instaloader" was added beside the logo inside the png.
2018-03-14 23:08:04 +01:00
.. image:: https://raw.githubusercontent.com/instaloader/instaloader/master/docs/logo_heading.png
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
::
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
$ pip3 install instaloader
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
$ instaloader profile [profile ...]
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
**Instaloader**
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Mention :saved in all places of documentation
2018-03-13 15:36:16 +01:00
- downloads **public and private profiles, hashtags, user stories,
feeds and saved media**,
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
- downloads **comments, geotags and captions** of each post,
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
- automatically **detects profile name changes** and renames the target
directory accordingly,
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Documentation Enhancements
2017-09-08 10:35:38 +02:00
- allows **fine-grained customization** of filters and where to store
downloaded media.
README: Document all of Instaloader's features
2017-04-22 11:58:59 +02:00
Added basic usage to README and documentation
2017-11-10 18:55:52 +01:00
::
Minor doc fixes and improvements
2018-08-24 11:38:45 +02:00
instaloader [--comments] [--geotags] [--stories] [--highlights] [--tagged]
Added basic usage to README and documentation
2017-11-10 18:55:52 +01:00
[--login YOUR-USERNAME] [--fast-update]
Mentione target :saved in README, docs and --help
2018-03-13 13:53:21 +01:00
profile | "#hashtag" | :stories | :feed | :saved
Added basic usage to README and documentation
2017-11-10 18:55:52 +01:00
Link to github pages doc hosting rather than rtd
2018-03-13 15:11:36 +01:00
`Instaloader Documentation <https://instaloader.github.io/>`__
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00
Restructure README.rst
2017-08-24 17:10:32 +02:00
How to Automatically Download Pictures from Instagram
Minimal updated description
2016-09-22 19:02:26 +02:00
-----------------------------------------------------
README: Document all of Instaloader's features
2017-04-22 11:58:59 +02:00
To **download all pictures and videos of a profile**, as well as the
**profile picture**, do
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
::
instaloader profile [profile ...]
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.
Minor enhancements to README
2017-04-22 12:11:56 +02:00
To later **update your local copy** of that profiles, you may run
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
::
instaloader --fast-update profile [profile ...]
Minor fixes to README.rst
2017-08-24 17:23:46 +02:00
If ``--fast-update`` is given, Instaloader stops when arriving at the
Restructure README.rst
2017-08-24 17:10:32 +02:00
first already-downloaded picture. When updating profiles, Instaloader
Documentation Enhancements
2017-09-08 10:35:38 +02:00
automatically **detects profile name changes** and renames the target directory
accordingly.
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Instaloader can also be used to **download private profiles**. To do so,
invoke it with
::
instaloader --login=your_username profile [profile ...]
Documentation Enhancements
2017-09-08 10:35:38 +02:00
When logging in, Instaloader **stores the session cookies** in a file in your
temporary directory, which will be reused later the next time ``--login``
is given. So you can download private profiles **non-interactively** when you
already have a valid session cookie file.
Use reStructuredText as file format for README rst seems to be cooler than md, and is the only format accepted by pypi, and is accepted by github as well. There is an intro to rst at: http://docutils.sourceforge.net/docs/user/rst/quickref.html
2016-09-19 19:45:15 +02:00
Link to github pages doc hosting rather than rtd
2018-03-13 15:11:36 +01:00
`Instaloader Documentation <https://instaloader.github.io/basic-usage.html>`__
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00
Minor documentation tunings
2017-08-25 22:38:54 +02:00
Added Disclaimer to README
2017-07-29 05:24:48 +02:00
Disclaimer
----------
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00
.. disclaimer-start
Instaloader is in no way affiliated with, authorized, maintained or endorsed by Instagram or any of its affiliates or
Minor enhancements Get rid of NonfatalException (an exception is nonfatal iff it is catched somewhere) Foreport fixes for #26 and #30. The current __sersion__ string is now kept in instaloader.py rather than setup.py. This lets instaloader.__version__ always deliver the version of the actually-loaded Instaloader module. Minor changes to README.rst, error handling and which class methods are public. With these and the changes of the previous commit, we saved 31 lines of code, indicating that it might be easier to understand and to maintain.
2017-08-11 17:50:37 +02:00
subsidiaries. This is an independent and unofficial project. Use at your own risk.
Mention IRC channel #instaloader on Freenode
2018-07-22 10:55:29 +02:00
Instaloader is licensed under an MIT license. Refer to ``LICENSE`` file for more information.
Create minimal documentation with Sphinx
2017-08-25 16:54:36 +02:00
.. disclaimer-end
Mention IRC channel #instaloader on Freenode
2018-07-22 10:55:29 +02:00
Contributing
------------
As an open source project, Instaloader heavily depends on the contributions from
its community. See
`contributing <https://instaloader.github.io/contributing.html>`__
for how you may help Instaloader to become an even greater tool.
It is a pleasure for us to share our Instaloader to the world, and we are proud
to have attracted such an active and motivating community, with so many users
who share their suggestions and ideas with us. Buying a community-sponsored beer
or coffee from time to time is very likely to further raise our passion for the
development of Instaloader.
Added BTC address to donations section Motivated by #130.
2018-07-23 23:36:46 +02:00
| For Donations, we provide a PayPal.Me link and a Bitcoin address.
| PayPal: `PayPal.me/aandergr <https://www.paypal.me/aandergr>`__
| BTC: 1Nst4LoadeYzrKjJ1DX9CpbLXBYE9RKLwY
Copy Permalink