Notify user if they are using an outdated version of Manim (#1237)

* Notify user if local version is outdated

Running the `manim` command will display the version number as green
if it is the latest detected on GitHub. Otherwise, display the version
number as red and let the user know that a newer version is available.

* Black formatting

* Add requests dependency

* Switch to PyPi API since it's not ratelimited

* Add CLI option for notifying local outdated build

Manim will notify user if local installation is outdated, after
rendering. This feature is enabled by default, but could be turned off
in config.

* Update notify_outdated_version instructions

* Please the flake

* Add documentation to configuration.rst

* Update poetry.lock

* Update option punctuation

* No need to inform users if they're up to date

* Move variable to within method

* Remove unused import

* Update dependencies

* Update outdated version message

* Run isort

* Fix typo

* Set `--notify_outdated_version` default to `None`

Flag value by default is None so config file will determine the value.
If flag is used then value is True.

* Convert CLRF to Unix newline LF (cleaner diffs)

* Remove argument check for outdated version

Too verbose, value should be configured via config

* Handle requests exceptions

* Update manim/cli/render/commands.py

Co-authored-by: Jason Villanueva <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Use f-strings for logger warnings

* Update poetry.lock

* Update manim/cli/render/commands.py

Co-authored-by: KingWampy <[email protected]>

* Update manim/cli/render/commands.py

Co-authored-by: KingWampy <[email protected]>

* Move print statements within try block

* Except JSONDecodeError only

* Update manim/cli/render/commands.py

Co-authored-by: Naveen M K <[email protected]>

* Update manim/cli/render/commands.py

Co-authored-by: Naveen M K <[email protected]>

* Don't raise exceptions, log in debug

Co-authored-by: Jason Villanueva <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: KingWampy <[email protected]>
Co-authored-by: Naveen M K <[email protected]>

Author: 5 people

docs/source/tutorials/configuration.rst

@@ -346,7 +346,7 @@ A list of all config options
    'frame_size', 'frame_width', 'frame_x_radius', 'frame_y_radius',
    'from_animation_number', 'images_dir', 'input_file', 'left_side',
    'log_dir', 'log_to_file', 'max_files_cached', 'media_dir', 'media_width',
-   'movie_file_extension', 'output_file', 'partial_movie_dir',
+   'movie_file_extension', 'notify_outdated_version', 'output_file', 'partial_movie_dir',
    'pixel_height', 'pixel_width', 'plugins', 'png_mode', 'preview',
    'progress_bar', 'quality', 'right_side', 'save_as_gif', 'save_last_frame',
    'save_pngs', 'scene_names', 'show_in_file_browser', 'sound', 'tex_dir',

manim/__main__.py

@@ -15,7 +15,7 @@ def exit_early(ctx, param, value):
         sys.exit()
 
 
-console.print(f"Manim Community [green]v{__version__}[/green]")
+console.print(f"Manim Community [green]v{__version__}[/green]\n")
 
 
 @click.group(

manim/_config/default.cfg

@@ -14,6 +14,9 @@
 # WRITE_TO_MOVIE = False so that running manim without the -w flag will not
 # generate a movie file.  Note all of the following accept boolean values.
 
+# --notify_outdated_version
+notify_outdated_version = True
+
 # -w, --write_to_movie
 write_to_movie = True
 

manim/_config/utils.py

@@ -256,6 +256,7 @@ class MyScene(Scene):
         "max_files_cached",
         "media_dir",
         "movie_file_extension",
+        "notify_outdated_version",
         "partial_movie_dir",
         "pixel_height",
         "pixel_width",
@@ -488,6 +489,7 @@ def digest_parser(self, parser: configparser.ConfigParser) -> "ManimConfig":
 
         # boolean keys
         for key in [
+            "notify_outdated_version",
             "write_to_movie",
             "save_last_frame",
             "write_all",
@@ -611,6 +613,7 @@ def digest_args(self, args: argparse.Namespace) -> "ManimConfig":
         self.output_file = args.output_file
 
         for key in [
+            "notify_outdated_version",
             "preview",
             "show_in_file_browser",
             "write_to_movie",
@@ -784,6 +787,12 @@ def log_to_file(self, val: str) -> None:
                 os.makedirs(log_dir)
             set_file_logger(self, self["verbosity"])
 
+    notify_outdated_version = property(
+        lambda self: self._d["notify_outdated_version"],
+        lambda self, val: self._set_boolean("notify_outdated_version", val),
+        doc="Whether to notify if there is a version update available.",
+    )
+
     write_to_movie = property(
         lambda self: self._d["write_to_movie"],
         lambda self, val: self._set_boolean("write_to_movie", val),

manim/cli/render/commands.py

@@ -5,14 +5,16 @@
 can specify options, and arguments for the render command.
 
 """
+import json
 import sys
 from pathlib import Path
 from textwrap import dedent
 
 import click
 import cloup
+import requests
 
-from ... import config, console, logger
+from ... import __version__, config, console, logger
 from ...constants import CONTEXT_SETTINGS, EPILOG
 from ...utils.module_ops import scene_classes_from_file
 from .ease_of_access_options import ease_of_access_options
@@ -136,4 +138,35 @@ def __repr__(self):
             except Exception:
                 console.print_exception()
 
+    if config.notify_outdated_version:
+        manim_info_url = "https://pypi.org/pypi/manim/json"
+        warn_prompt = "Cannot check if latest release of manim is installed"
+        req_info = {}
+
+        try:
+            req_info = requests.get(manim_info_url)
+            req_info.raise_for_status()
+        except requests.exceptions.HTTPError:
+            logger.debug(f"HTTP Error: {warn_prompt}")
+        except requests.exceptions.ConnectionError:
+            logger.debug(f"Connection Error: {warn_prompt}")
+        except requests.exceptions.Timeout:
+            logger.debug(f"Timed Out: {warn_prompt}")
+        except Exception:
+            logger.debug(f"Something went wrong: {warn_prompt}")
+
+        try:
+            stable = req_info.json()["info"]["version"]
+
+            if stable != __version__:
+                console.print(
+                    f"You are using manim version [red]v{__version__}[/red], but version [green]v{stable}[/green] is available."
+                )
+                console.print(
+                    "You should consider upgrading via [yellow]pip install -U manim[/yellow]"
+                )
+        except json.JSONDecodeError:
+            logger.debug(warn_prompt)
+            logger.debug(f"Error decoding JSON from {manim_info_url}")
+
     return args

manim/cli/render/global_options.py

@@ -30,4 +30,10 @@
         ),
         help="Verbosity of CLI output. Changes ffmpeg log level unless 5+.",
     ),
+    option(
+        "--notify_outdated_version/--silent",
+        is_flag=True,
+        default=None,
+        help="Display warnings for outdated installation.",
+    ),
 )