check for updates (#854)

CHANGELOG.md

@@ -12,6 +12,7 @@ Instructions: Add a subsection under `[UNRELEASED]` for additions, fixes, change
 ### Added
 
 - Support for generating prefigure graphics.
+- Always checks whether there is a new version of the CLI available.
 
 ## [2.8.2] - 2024-11-05
 

pretext/cli.py

@@ -148,7 +148,15 @@ def main(ctx: click.Context, targets: bool) -> None:
         fh.setFormatter(file_log_format)
         log.addHandler(fh)
         # output info
-        log.info(f"PreTeXt-CLI version: {VERSION}\n")
+        latest_version = utils.latest_version()
+        if latest_version and latest_version != VERSION:
+            log.info(
+                f"Using PreTeXt-CLI version {VERSION}.  The latest stable version available is {latest_version}. Run `pip install pretext --upgrade` to update.\n"
+            )
+        else:
+            log.info(
+                f"Using PreTeXt-CLI version: {VERSION}.  This is the latest available version.\n"
+            )
         log.info(f"PreTeXt project found in `{utils.project_path()}`.")
         # permanently change working directory for rest of process
         os.chdir(pp)

pretext/utils.py

@@ -762,3 +762,19 @@ def pelican_default_settings() -> t.Dict[str, t.Any]:
     # for now, all PTX_ custom settings are strings (due to use of XML)
     config["PTX_SHOW_TARGETS"] = "yes"
     return config
+
+
+def latest_version() -> t.Optional[str]:
+    """
+    Get the latest version of the pretext package from PyPI.
+    """
+    import requests
+
+    url = "https://pypi.org/pypi/pretext/json"
+    try:
+        response = requests.get(url)
+        return response.json()["info"]["version"]
+    except Exception as e:
+        log.debug("Could not determine latest version of pretext.")
+        log.debug(e, exc_info=True)
+        return None