Prepare for version 3.3.0

README.md

@@ -3,40 +3,25 @@ Active development for this script has ended. Issues will no longer be looked in
 
 
 # PyInstaLive
-![Version 3.2.4](https://img.shields.io/badge/Version-3.2.4-orange.svg)
-![Python 2.7, 3.5](https://img.shields.io/badge/Python-2.7%2C%203.5%2B-3776ab.svg)
+![Version 3.3.0](https://img.shields.io/badge/Version-3.3.0-orange.svg)
+![Python 3.6+](https://img.shields.io/badge/Python-3.6%2B-3776ab.svg)
 
-[![Support me!](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/dvingerh)
 
-
-This Python script enables you to download any ongoing Instagram livestreams as well as any available replays. It is based on [another script](https://github.com/taengstagram/instagram-livestream-downloader) that has now been discontinued.
+This Python script enables you to download ongoing Instagram livestreams as a video file.
 
 ![](https://raw.githubusercontent.com/dvingerh/PyInstaLive/5907fc866446d5f426389a5198560075848d770e/.github/spacer.png)
 
 
 ## Table of Contents
-- [Features](https://github.com/dvingerh/PyInstaLive#features)
 - [Quickstart](https://github.com/dvingerh/PyInstaLive#quickstart)
 - [Installation](https://github.com/dvingerh/PyInstaLive#installation)
 - [Usage](https://github.com/dvingerh/PyInstaLive#usage)
-- [Notes](https://github.com/dvingerh/PyInstaLive#notes)
 - [Help](https://github.com/dvingerh/PyInstaLive#help)
 
 ![](https://raw.githubusercontent.com/dvingerh/PyInstaLive/5907fc866446d5f426389a5198560075848d770e/.github/spacer.png)
 
-## Main Features
-
-PyInstaLive is capable of downloading:
-- Ongoing livestreams (also detects livestreams where the specified user is being guested).
-- Saved replays.
-- Livestream and replay comments.
-- Available livestreams and replays from your following user feed, concurrently.
-
-![](https://raw.githubusercontent.com/dvingerh/PyInstaLive/5907fc866446d5f426389a5198560075848d770e/.github/spacer.png)
-
 ## Quickstart
 
-- [Read the Notes & Help sections below (important!)](https://github.com/notcammy/PyInstaLive#notes)
 - Install the prerequisites and then PyInstaLive.
 - Run `pyinstalive` to generate a default configuration file.
 - Edit the configuration file using any text editor.
@@ -48,7 +33,7 @@ PyInstaLive is capable of downloading:
 
 - [ffmpeg](https://ffmpeg.org/download.html)
 - [Git](https://git-scm.com/downloads)
-- [Python 2.7.x or 3.5>=](https://www.python.org/downloads/)
+- [Python 3.6+](https://www.python.org/downloads/)
 - [pip + setuptools](https://pip.pypa.io/en/stable/installing/)
 
 Make sure all tools are accessible via command line (added to your PATH if on Windows, use Google).
@@ -57,21 +42,21 @@ Make sure all tools are accessible via command line (added to your PATH if on Wi
 
 ## Installation
 
-*Tip — To install PyInstaLive with the latest commit changes, remove the version tag from the install command (e.g. **@3.2.4**).*
+*Tip — To install PyInstaLive with the latest commit changes, remove the version tag from the install command (e.g. **@3.3.0**).*
 
 #### Installing
 
 Run the following command in your command line (might need to be run as administrator on Windows):
 ```bash
-pip install git+https://github.com/dvingerh/PyInstaLive.git@3.2.4
+pip install git+https://github.com/dvingerh/PyInstaLive.git@3.3.0
 ```
 
 #### Updating
 
-To update PyInstaLive to the latest version (currently **3.2.4**) run the following command:
+To update PyInstaLive to the latest version (currently **3.3.0**) run the following command:
 
 ```bash
-pip install git+https://github.com/dvingerh/PyInstaLive.git@3.2.4 --upgrade
+pip install git+https://github.com/dvingerh/PyInstaLive.git@3.3.0 --upgrade
 ```
 
 #### Specific versions
@@ -98,17 +83,13 @@ Here is an example of a valid configuration file:
 username = johndoe
 password = grapefruits
 download_path = 
-download_lives = True
-download_replays = True
-download_comments = true
 show_cookie_expiry = True
 log_to_file = True
 ffmpeg_path = 
 run_at_start =
 run_at_finish =
 use_locks = True
 clear_temp_files = False
-do_heartbeat = True
 proxy = 
 skip_merge = False
 ```
@@ -129,46 +110,42 @@ Below is an example of PyInstaLive's output after downloading a livestream:
 > pyinstalive -d "janedoe"
 
 ---------------------------------------------------------------------------
-[I] PYINSTALIVE (SCRIPT V3.2.4 - PYTHON V3.6.3) - 01-02-2019 06:56:29 PM
+[I] PYINSTALIVE (SCRIPT V3.3.0 - PYTHON V3.8.10) - 08-12-2021 02:23:37 PM
+---------------------------------------------------------------------------
+[I] Using an existing login session file: johndoe.dat
+[I] Login session file expiry date: 2022-08-06 at 12:13:03 AM
 ---------------------------------------------------------------------------
 [I] Successfully logged into account: johndoe
 ---------------------------------------------------------------------------
-[I] Getting info for 'janedoe' successful.
+[I] Getting livestream info for user: janedoe
 ---------------------------------------------------------------------------
 [I] Livestream available, starting download.
 ---------------------------------------------------------------------------
-[I] Username    : janedoe
-[I] Viewers     : 335 watching
-[I] Airing time : 2 minutes and 8 seconds
-[I] Status      : Active
+[I] Airing time  : 2 minutes and 38 seconds
+[I] Status       : Active
+[I] Viewers      : 492
 ---------------------------------------------------------------------------
 [I] Downloading livestream, press [CTRL+C] to abort.
 ---------------------------------------------------------------------------
 [I] The livestream has been ended by the user.
 ---------------------------------------------------------------------------
-[I] Airtime duration  : 3 minutes and 13 seconds
-[I] Download duration : 1 minutes and 7 seconds
-[I] Missing (approx.) : 2 minutes and 6 seconds
+[I] Airing time  : 8 minutes and 46 seconds
+[I] Downloaded   : 6 minutes and 8 seconds
+[I] Missing      : 2 minutes and 38 seconds
 ---------------------------------------------------------------------------
-[I] Waiting for comment downloader to finish.
-[I] Successfully saved 19 comments.
+[W] Final video duration may vary if the livestream was interrupted.
 ---------------------------------------------------------------------------
+[I] Waiting for background threads to finish.
 [I] Merging downloaded files into video.
-[I] Successfully merged downloaded files into video.
 ---------------------------------------------------------------------------
-[I] There are no available replays.
+[I] Saved video: 20210812_janedoe_17931255316652921_1628771017_live.mp4
+---------------------------------------------------------------------------
+[I] Successfully merged downloaded files into video.
 ---------------------------------------------------------------------------
 ```
 
 ![](https://raw.githubusercontent.com/dvingerh/PyInstaLive/5907fc866446d5f426389a5198560075848d770e/.github/spacer.png)
 
-## Notes
-- I have not much time to extensively test the changes I make to the code, so when you do encounter a problem please [open an issue](https://github.com/dvingerh/PyInstaLive/issues/new) and try using an older version of PyInstaLive in the meantime.
-
-- Python 2 cannot save most unicode characters in comments such as emojis if it's not built from source using the `--enable-unicode=ucs4` argument. Read more about this [here](https://emoji-unicode.readthedocs.io/en/latest/python2.html). This should probably not affect pre-installed Python 2 installations on Linux-based systems such as Ubuntu or Debian.
-
-![](https://raw.githubusercontent.com/dvingerh/PyInstaLive/5907fc866446d5f426389a5198560075848d770e/.github/spacer.png)
-
 
 ## Help
 You can find a list of frequently asked questions [here](https://github.com/dvingerh/PyInstaLive/blob/master/FAQ.md).