|
13 | 13 |
|
14 | 14 | - ```-cl``` or ```--clean``` **—** PyInstaLive clean the current download folder by deleting folders ending in `_downloads`. Any folders that contain a `folder.lock` file (e.g. folders for ongoing downloads) will be skipped. |
15 | 15 |
|
16 | | -- ```-df``` or ```--download-following``` **—** PyInstaLive will check if any users from your following list have any available livestreams or replays and start a daemon process running PyInstaLive in the background for those that do. You cannot cancel the launched processes or start them with any extra arguments. It's recommended to enable ```log_to_file``` when using this argument. (Experimental, use at own risk.) |
| 16 | +- ```-df``` or ```--download-following``` **—** PyInstaLive will check if any users from your following list have any available livestreams and start a daemon process running PyInstaLive in the background for those that do. You cannot cancel the launched processes or start them with any extra arguments. It's recommended to enable ```log_to_file``` when using this argument. (Experimental, use at own risk.) |
17 | 17 |
|
18 | 18 | - ```-cp``` or ```--config-path``` **—** Passing this argument along with a valid path to a different configuration file will override the default path used by PyInstaLive (the current directory you are executing the script in). |
19 | 19 |
|
|
23 | 23 |
|
24 | 24 | - ```-b``` or ```--batch-file``` **—** PyInstaLive will check the users inside a text file for any available livestreams or replays. |
25 | 25 |
|
26 | | -- ```-o``` or ```--organize``` **—** (**In testing, use at your own discretion**) Passing this argument will create a folder for each user whose livestream(s) you have downloaded. The names of the folders will be their usernames. It will then move the video and log files of each user into their associated folder and rename the files to a more friendly format. Example filename: ```19-04-2020 06-02-10-PM johndoe (replay).mp4```. Temporary file segment folders will not be moved. |
| 26 | +- ```-o``` or ```--organize``` **—** (**In testing, use at your own discretion**) Passing this argument will create a folder for each user whose livestream(s) you have downloaded. The names of the folders will be their usernames. It will then move the video and log files of each user into their associated folder and rename the files to a more friendly format. Example filename: ```19-04-2020 06-02-10-PM johndoe.mp4```. Temporary file segment folders will not be moved. |
27 | 27 |
|
28 | 28 | - ```-sm``` or ```--skip-assemble``` **—** PyInstaLive will not assemble any download livestream files when this argument is used. |
29 | 29 |
|
|
35 | 35 | username = johndoe |
36 | 36 | password = grapefruits |
37 | 37 | download_path = |
38 | | -show_cookie_expiry = True |
39 | | -log_to_file = True |
40 | | -ffmpeg_path = |
41 | | -run_at_start = |
42 | | -run_at_finish = |
43 | | -use_locks = True |
| 38 | +show_session_expires = True |
| 39 | +download_comments = True |
44 | 40 | clear_temp_files = False |
45 | | -do_heartbeat = True |
46 | | -proxy = |
| 41 | +cmd_on_started = |
| 42 | +cmd_on_ended = |
| 43 | +ffmpeg_path = |
| 44 | +log_to_file = True |
47 | 45 | skip_assemble = False |
| 46 | +use_locks = True |
48 | 47 | ``` |
49 | 48 |
|
50 | 49 | ```username``` **—** Instagram username to login with. |
51 | 50 |
|
52 | 51 | ```password``` **—** Instagram password to login with. |
53 | 52 |
|
54 | | -```download_path``` **—** Path to the folder where downloaded Instagram livestreams and replays will be saved. PyInstaLive must have permission to write files to this folder. If left empty, PyInstaLive will attempt to fall back to the folder where it's being run from. |
| 53 | +```download_path``` **—** Path to the folder where downloaded Instagram livestreams will be saved. PyInstaLive must have permission to write files to this folder. If left empty, PyInstaLive will attempt to fall back to the folder where it's being run from. |
55 | 54 |
|
56 | | -```download_lives``` **—** When set to True, PyInstaLive will download livestreams. |
57 | | - |
58 | | -```download_replays``` **—** When set to True, PyInstaLive will download any available replays. |
59 | | - |
60 | | -```download_comments``` **—** When set to true, PyInstaLive will try to download comments from a livestream or replay to a log file. Verified users have *(v)* next to their name. |
| 55 | +```download_comments``` **—** When set to true, PyInstaLive will try to download comments from a livestream to a text file. |
61 | 56 |
|
62 | 57 | ```show_cookie_expiry``` **—** When set to True, PyInstaLive will show when the current cookie used to login will expire. |
63 | 58 |
|
64 | 59 | ```log_to_file``` **—** When set to true, PyInstaLive will save all its console logs to a text file. The filename will be `pyinstalive_<live-username>.log` where `<live_username>` will be the username of the Instagram user whose livestream or replay you want to download. If no username was given to download (e.g when running `pyinstalive --clean`) the file will be named `pyinstalive.default.log`. |
65 | 60 |
|
66 | 61 | ```ffmpeg_path``` **—** User-defined path to the FFmpeg binary (e.g. `C:\Users\Username\Desktop\ffmpeg.exe`). If left empty, PyInstaLive will fall back to the system's environment variable. |
67 | 62 |
|
68 | | -```run_at_start``` **—** Command to run when PyInstaLive starts downloading a livestream. Leave empty to disable. (Experimental feature) |
| 63 | +```cmd_on_started``` **—** Command to run when PyInstaLive starts downloading a livestream. Leave empty to disable. (Experimental feature) |
69 | 64 |
|
70 | | -```run_at_finish``` **—** Command to run when PyInstaLive finishes downloading a livestream. Leave empty to disable. (Experimental feature) |
| 65 | +```cmd_on_ended``` **—** Command to run when PyInstaLive finishes downloading a livestream. Leave empty to disable. (Experimental feature) |
71 | 66 |
|
72 | 67 | ```use_locks``` **—** When set to true, PyInstaLive will create several .lock files to prevent duplicate downloads from starting for the same user if you are running PyInstaLive using some form of automation such as batch/shell loops. |
73 | 68 |
|
74 | | -```clear_temp_files``` **—** When set to True, PyInstaLive will delete all temporary files that were downloaded as well as the folders which contained these files. Replay folders created by PyInstaLive will not be deleted because they are used to determine if a replay has already been downloaded. |
75 | | - |
76 | | -```do_heartbeat``` **—** When set to True, PyInstaLive will check the livestream's active status. If set to False no checks will be conducted, and the logged in user will not show up as a viewer during the livestream. May cause degraded performance. |
77 | | - |
78 | | -```proxy``` **— ** When set, PyInstaLive will use the specified HTTP proxy. The format should be similar to http://user:[email protected]:12345 |
79 | | - |
80 | | - |
| 69 | +```clear_temp_files``` **—** When set to True, PyInstaLive will delete all temporary files that were downloaded as well as the folders which contained these files. Replay folders created by PyInstaLive will not be deleted because they are used to determine if a replay has already been downloaded. |
0 commit comments