Alexander Graf
e21d34124d
Add codesnippet for almost chronological order
...
Such as for downloading hashtag feeds, as discussed in #666 and contributed by
@e2tovar.
Also change comment color to grey in codesnippets in documentation.
2020-06-21 19:38:16 +02:00
michalens
66b3ec6928
Add explanation on downloading single post ( #694 )
2020-06-19 19:39:08 +02:00
Alexander Graf
0c93e63615
Update troubleshooting.rst, Minor fixes to contributing.rst
2020-06-16 21:44:22 +02:00
Alexander Graf
65025e61d9
Update issue/PR templates, contributing.rst, CI
...
- Keep documentation in sync with master branch
- Run PyLint and MyPy on Github Actions
- Update Issue templates, enforce usage of issue templates, add links to
resources in Instaloader Documentation
- Update contributing.rst
2020-06-16 20:26:58 +02:00
Alexander Graf
2345d90e0e
Fix docs building on Windows
2020-06-09 13:03:48 +02:00
Alexander Graf
ed499cb49c
Let --sessionfile default to a more persistent path ( #659 )
...
The presence of a sessionfile avoids the usage of the failure-prone login
mechanism. This commit addresses a suggestion in #615 to store the sessionfile
in a persistent path rather than a path within a temporary directory if no
--sessionfile parameter is given.
The default path is now:
$XDG_CONFIG_HOME/instaloader/session-USERNAME or
~/.config/instaloader/session-USERNAME on Unix,
%LOCALAPPDATA%\Instaloader\session-USERNAME on Windows.
If no file exists in the new path, Instaloader tries loading from the path
where the sessionfile was stored before this commit, hence it automatically
migrates to the new sessionfile path.
2020-06-06 10:49:41 +02:00
Alexander Graf
c818165db4
Update 615_import_firefox_session.py
...
This fixes finding the cookies.sqlite file on MacOS as per https://github.com/instaloader/instaloader/issues/92#issuecomment-638361344 .
2020-06-03 20:07:52 +02:00
Alexander Graf
26a78463f1
doc: Discourage using --commit-mode
...
--commit-mode has many bugs, especially #257 , #483 . For now we discourage using
it until it is reimplemented.
2020-06-03 18:03:27 +02:00
Alexander Graf
689dd3613b
doc: Minor style-related changes to code examples
2020-06-03 18:03:01 +02:00
Alexander Graf
27b7c98be2
Update doc section Troubleshooting -> Login Error
...
New Firefox cookie import script, based on a comment in #615 :
https://github.com/instaloader/instaloader/issues/615#issuecomment-630127064
2020-06-03 17:14:08 +02:00
Alexander Graf
83a0f52c60
Hashtag class
2020-04-17 18:49:38 +02:00
Alexander Graf
78a93c945e
Revert "Revert "Remove nonworking saythanks.io link""
...
saythanks.io does not work again and the link is now removed.
This reverts commit b2acbcf0e0
.
2020-03-14 17:56:44 +01:00
Alexander Graf
6cc2ed54ea
Download IGTV Videos of a Profile (--igtv)
2020-03-14 16:56:51 +01:00
Alexander Graf
534497bea5
fix misplacement of --request-timeout in docs
2020-02-28 09:49:29 +01:00
Alexander Graf
0aac91680f
docs: versionadded/changed directives for 4.3
2020-02-17 18:47:45 +01:00
Alexander Graf
b2acbcf0e0
Revert "Remove nonworking saythanks.io link"
...
saythanks.io works again. This reverts commit
f966ea5bb9
.
2020-02-04 09:23:02 +01:00
Alexander Graf
f966ea5bb9
Remove nonworking saythanks.io link
...
saythanks.io stopped working, BlitzKraft/saythanks.io#60 .
2020-01-27 21:31:47 +01:00
André Koch-Kramer
d3403bc686
Implementation of TopSearchResults class
...
To be able to search Instagram for profiles, hashtags and locations.
2020-01-27 13:06:42 +01:00
corpone2
63eb9e71ca
support passing timeout to requests ( #422 )
...
Adds a request_timeout parameter to Instaloader instantiation.
Closes #330 .
2020-01-13 21:59:00 +01:00
Leonard Bogdonoff
cf293ce312
Change Example Hashtag in Codesnippets
2019-10-13 19:47:44 +02:00
Alexander Graf
3226c43a98
Fix Intersphinx Mapping for Requests to fix CI
2019-10-13 19:45:14 +02:00
Alexander Graf
4e8236b6e9
Improve contributing.rst and issue templates
2019-08-20 22:05:49 +02:00
Alexander Graf
0aa1ec7c76
Getting locations now requires --login
...
Closes #376 .
2019-08-18 10:48:46 +02:00
Alexander Graf
75a729781d
194_top_x_of_user example: Fix sort order
2019-08-10 16:25:22 +02:00
Alexander Graf
8ef7b3242c
Add trendy Badges to README.rst and index.rst
2019-05-07 18:01:13 +02:00
André Koch-Kramer
0fd06fe6bc
Remove needlessly complicated code
2019-03-31 15:55:25 +02:00
André Koch-Kramer
15d9cd8949
Adjust structure to handle new threaded comments
...
This is needed because of a structure change by Instagram.
Fixes #272 .
2019-03-31 11:29:07 +02:00
André Koch-Kramer
a0b7804fd2
Properly handle redirected posts
...
Resolves #225 .
2019-02-10 18:24:33 +01:00
Alexander Graf
e39ffecea4
Minor doc changes
...
- Add saythanks.io link
- Set lang="en" attribute in html tag
2019-01-24 22:39:58 +01:00
Alexander Graf
27a239f07f
doc theme: Improve consistency of code highlight
2019-01-17 11:39:18 +01:00
Alexander Graf
bb25f03c7d
doc: "Troubleshooting" section + minor changes
2019-01-17 11:00:04 +01:00
Alexander Graf
d2bebcd00c
doc: Fix +args.txt description
...
- Fix wrong `--option value`, which must be `--option=value`
- Fix typos
Fixes #221 .
2019-01-03 17:05:43 +01:00
Alexander Graf
06845b53fc
Fixes and enhancements to documentation theme
2019-01-01 14:23:08 +01:00
Alexander Graf
e9cec0b261
docs/conf.py: remove unneeded import
2018-12-31 19:35:55 +01:00
Alexander Graf
ac4cd9f595
New doc design: Sphinx Bootstrap 4 Theme
...
Now we use an own, mobile-first, responsive sphinx theme based on Bootstrap 4.
It makes navigation on the very long "Python module instaloader" page a lot
easier. Also, it looks better.
This solves all the problems we had with sphinx-bootstrap-theme.
2018-12-31 19:30:19 +01:00
André Koch-Kramer
4ee867c61b
Implement two-factor authentication
...
Closes #200 .
2018-12-21 21:58:12 +01:00
Alexander Graf
a735b02bac
doc: Add 'versionadded' directives to new features
2018-12-21 14:43:33 +01:00
Stijn Peeters
be5d02ef3b
Location search ( #212 )
...
* Add %location search option
Search for posts for a given location ID using %[location id] as the query
* Document %location search
* Make pylint happy
* Use correct paths for location results
* Fix —help output
Add description of location argument and fix output error for short help.
* Add unit tests for location download
* Add extra unit test for locations
2018-12-17 21:35:31 +01:00
Alexander Graf
1ab9e44104
Update sphinx_autodoc_typehints to version 1.5.2
2018-12-13 16:23:14 +01:00
sushilicious
30555b576c
Added commit mode
...
The commit mode ensures pictures are not corrupted when Instaloader is
unexpectedly interrupted. In the case that the last picture is corrupted
because of an interruption, Instaloader will redownload the picture.
Since the metadata is the last object saved to disk, we can consider a
post as "committed" if its json metadata file exists and is not
malformed. Instaloader should download any posts which are not
committed. Downside is commit mode requires metadata to be saved.
2018-12-09 02:12:45 -05:00
Alexander Graf
5a7b76db31
Merge branch 'v4.1-dev'
2018-09-02 21:56:16 +02:00
Alexander Graf
18707ee232
docs: Better explanation for is_video
...
Closes #173 .
2018-08-30 10:16:56 +02:00
Alexander Graf
084424e856
docs/codesnippets: Link to source tree on github
2018-08-30 09:18:58 +02:00
Alexander Graf
86204d165d
Merge branch 'master' into v4.1-dev
2018-08-24 12:45:12 +02:00
Alexander Graf
d0e2ac4388
docs/install: Suggest pre-release rather than git
2018-08-24 12:42:51 +02:00
Alexander Graf
b443cc6654
Minor doc fixes and improvements
2018-08-24 11:53:14 +02:00
André Koch-Kramer
584c69d93c
Update docs and docstrings concerning highlights
2018-08-24 00:23:19 +02:00
Alexander Graf
43f52198ff
Fix docs building and show Highlights inheritance
2018-08-23 22:19:08 +02:00
André Koch-Kramer
91d5d5f867
Add class and functions for downloading highlights
...
Requested in #162 .
2018-08-23 22:19:08 +02:00
Alexander Graf
0dcc912987
doc: Note new features with versionadded
2018-08-23 17:25:28 +02:00
Alexander Graf
180d398ad7
docs: Exclude sphinx-1.7.7 to fix travis build
2018-08-23 16:14:02 +02:00
Alexander Graf
b91e73b090
set docs font size to 16px
2018-08-23 14:44:37 +02:00
Alexander Graf
e388a1c966
--no-posts; Deprecate --{profile-pic,stories}-only
2018-08-20 16:29:14 +02:00
Alexander Graf
0f0ac13d72
reorder --help output
2018-08-20 14:27:58 +02:00
Alexander Graf
06b7edd6d5
--no-pictures flag to not download post pictures
...
Closes #131 .
2018-08-20 14:27:58 +02:00
Alexander Graf
5f57345f1b
"instaloader -- -SHORTCODE" to fetch single post
...
Closes #129 .
2018-08-20 14:27:58 +02:00
Alexander Graf
f7e6632f68
Document --tagged{,-only} in docs/cli-options.rst
2018-08-20 10:44:20 +02:00
AndCycle
9258b84695
Allow reading arguments from file
...
Squashed commit of the following (pr #161 ):
commit 58235a99b0
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:57:26 2018 +0800
doc: proper fix rst syntax
commit 6620e3583c
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:29:25 2018 +0800
doc: fix syntax
commit 7a048a3c04
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:09:26 2018 +0800
doc: add info about read args from file.
commit c4ceaf9636
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Thu Aug 16 17:05:07 2018 +0800
alter `fromfile_prefix_chars` to plus sign to avoid conflict.
commit d469b52b95
Author: AndCycle <andcycle@andcycle.idv.tw>
Date: Mon Aug 6 19:10:23 2018 +0800
* Allow reading arguments from file
function referenced from instagram-scraper,
which provide a convenient way to hide sensitive information.
2018-08-20 09:00:51 +02:00
Alexander Graf
998333b7cd
Revert "Mention IRC channel #instaloader on Freenode"
...
This reverts commit 8423e3bd00
. The channel did
not have as much activity as expected and an IRC channel does not work if there
are not at least a few people in it.
2018-08-07 19:57:10 +02:00
André Koch-Kramer
0ebb223214
Added BTC address to donations section
...
Motivated by #130 .
2018-07-23 23:36:46 +02:00
Alexander Graf
8423e3bd00
Mention IRC channel #instaloader on Freenode
2018-07-22 10:55:29 +02:00
Alexander Graf
3cb33603e5
doc: Use Instaloader brand colors for links
2018-07-09 21:32:18 +02:00
Alexander Graf
8211c9daf1
Documentation Improvements
...
- Fix Spelling
- codesnippets: Improve introduction texts; Write subsection about
metadata JSON files
2018-06-17 18:10:19 +02:00
Alexander Graf
4cf1ae847d
Mention donation option in doc
...
(Suggested by #130 )
2018-06-13 08:39:29 +02:00
Alexander Graf
45fe509ac4
doc: Link codesnippets in basic-usage
2018-06-04 12:06:41 +02:00
Alexander Graf
ae492ed68b
New doc section: codesnippets / Advanced Examples
...
Presents code examples that use the instaloader module for more advanced tasks
than what is possible with the Instaloader command line interface.
Presents #46 , #56 , #110 , #113 , #120 , #121 .
2018-06-04 11:57:28 +02:00
Alexander Graf
60d35a95df
docs: note that --stories-only @login is bad
...
Motivated by #112 , #118 .
2018-05-14 11:04:48 +02:00
Alexander Graf
d19dd2c9d4
Fix internal references in docs/as-module
...
Further, document all attributes that are referred to, and ensure that there
will be no broken references again by letting Travis call Sphinx with -W -n.
2018-05-14 10:46:04 +02:00
Alexander Graf
a3a09e1952
Very minor tweak to a paragraph in basic-usage.rst
2018-05-02 17:26:53 +02:00
Alexander Graf
2722da6ae4
Fix anon username from id (find renamed profile)
...
maybe related to #95 , #104 , 67ac8f3397
.
2018-05-01 13:11:40 +02:00
Alexander Graf
1469064176
Minor documentation tweaks
...
- Instaloader as Cronjob sections
- Many new internal links to ease navigation
2018-04-30 09:56:43 +02:00
Alexander Graf
dba74ab8d4
Minor documentation improvements
2018-04-29 16:41:24 +02:00
Alexander Graf
dd80ef484c
Improve formatting of basic-usage/what-to-download
2018-04-29 16:26:31 +02:00
Alexander Graf
6117e223a7
Describe Metadata Text Files Feature
2018-04-29 16:24:55 +02:00
Alexander Graf
7c76202f1c
Update documentation regarding v4 changes
...
as-module.rst: List how Post and Profile is created
Describe new filename specification logic
Update filter-posts section
2018-04-29 13:33:25 +02:00
Alexander Graf
d21fb4154e
fine-tune as-module.rst
2018-04-28 21:45:57 +02:00
Alexander Graf
7edc69454d
doc: Fix links to Instaloader classes
2018-04-28 19:50:14 +02:00
Alexander Graf
2c50972e08
Update as-module.rst and docstrings
2018-04-28 15:47:04 +02:00
Alexander Graf
b9ac40899d
Theme-related Documentation Enhancements
...
- Consistent background color in all types of codes
- Improve dd (list item) padding
- Link to Index in global TOC in navbar
- Briefly describe Instaloader in `index.html` title
- Remove page contents (navbartoc) in index, genindex and installation
- Link to new pypi.org rather than old pypi.python.org
2018-04-28 15:47:04 +02:00
Alexander Graf
7d2830b8b2
Have --storyitem-filter (--only-if for StoryItems)
2018-04-19 15:12:05 +02:00
Alexander Graf
59152214cf
Allow specification of what to write in txt files
2018-04-13 22:54:40 +02:00
Alexander Graf
df1cdb5d48
Remove now-unneeded Tristate
2018-04-13 19:07:23 +02:00
Alexander Graf
f0bebd0d96
Saving and reimporting of JSON files
...
Metadata JSON files are now created by default. They can later be given
as a target to redownload Posts, StoryItems or Profiles with new
settings.
2018-04-12 22:03:02 +02:00
Alexander Graf
235522dfd7
Merge branch 'master' into v4-dev
2018-03-31 15:06:39 +02:00
André Koch-Kramer
40a87761c9
Mention Windows standalone exe in documentation
2018-03-29 19:47:35 +02:00
Alexander Graf
d533c60824
doc: Switch to mobile-friendlier bootstrap theme
...
It seems to be better supported than Alabaster and is easier to be
configured to look good on both a phone and a desktop.
2018-03-28 19:39:58 +02:00
Alexander Graf
539273b963
make doc more mobile-friendly
2018-03-24 21:47:35 +01:00
Alexander Graf
36110c8727
Disable search engine indexing on old doc hoster
2018-03-24 12:37:24 +01:00
Alexander Graf
4a944fbbdb
doc: meta tag to redirect to new documentation URL
2018-03-24 11:32:53 +01:00
Alexander Graf
a492f0a6d1
Merge branch 'master' into v4-dev
2018-03-22 16:10:35 +01:00
Alexander Graf
6764cd961f
Tweak documentation description html meta tags
2018-03-22 16:07:19 +01:00
Alexander Graf
4a2e32790a
Minor documentation improvements
...
- List all __init__ methods in documentation
- Further describe purpose of Profile in its docstring
2018-03-18 17:19:22 +01:00
Alexander Graf
760688d9e6
Profile class abstracting profile structure
2018-03-18 16:31:32 +01:00
Alexander Graf
279de0a641
List all Exceptions in doc, fix name inconsistcies
2018-03-18 16:29:34 +01:00
André Koch-Kramer
b2f31e7782
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
Alexander Graf
68d8f65cb9
Add logo in documentation sidebar
2018-03-14 22:14:24 +01:00
Alexander Graf
e97e4ecdc8
Further enhance logo
2018-03-14 19:41:20 +01:00
Alexander Graf
e77c998a94
Invent beautiful logo and use it as doc favicon
2018-03-14 19:09:24 +01:00
Alexander Graf
14e9cf435e
Fix download of saved posts
...
(was broken with commit 83b31175df
, due to
a slight modification of Instaloader.get_profile_metadata)
2018-03-14 08:41:48 +01:00
Alexander Graf
92114f9018
Add message on instaloader.rtfd.io that doc moved
2018-03-13 16:58:00 +01:00