Merge pull request #634 from hx2A/finish-processing-library-stuff

Finish processing library stuff

Author: hx2A

generator/reference.py

@@ -375,7 +375,13 @@
     ("Py5Tools", "processing_download_library"): [
         (
             ["library_name: str"],
-            "bool",
+            "dict",
+        )
+    ],
+    ("Py5Tools", "processing_remove_library"): [
+        (
+            ["library_name: str"],
+            "None",
         )
     ],
 }

py5_docs/Reference/api_en/Py5Tools_processing_check_library.txt

@@ -14,3 +14,9 @@ library_name: str - name of Processing library
 Check if a Processing library has been downloaded and stored by py5. These are the same libraries available to you in the Library Manager when you use the Processing Development Environment (PDE). Downloaded libraries are available for you to import in Python after you import py5.
 
 Downloaded libraries will be saved in the Processing library storage directory. Use [](py5tools_processing_library_storage_dir) to get the specific location of the storage directory on your machine.
+
+@@ example
+import py5_tools
+
+if py5_tools.processing.check_library("PeasyCam"):
+    print("PeasyCam is in your stored library")

py5_docs/Reference/api_en/Py5Tools_processing_download_library.txt

@@ -5,12 +5,32 @@ category = processing
 subcategory = None
 
 @@ signatures
-processing_download_library(library_name: str) -> bool
+processing_download_library(library_name: str) -> dict
 
 @@ variables
 library_name: str - name of Processing library
 
 @@ description
 Download and store a Processing library. These are the same libraries available to you in the Library Manager when you use the Processing Development Environment (PDE). After this function downloads a Processing library, it will be available for you to import in Python after you import py5.
 
+This function will also return a dictionary containing some basic information about the installed library. If the library was previously downloaded, it will check the version numbers and will update the library if it is not current. If you want to remove an installed library, use [](py5tools_processing_remove_library).
+
 Downloaded libraries will be saved in the Processing library storage directory. Use [](py5tools_processing_library_storage_dir) to get the specific location of the storage directory on your machine.
+
+@@ example
+import py5_tools
+
+py5_tools.processing.download_library("PeasyCam")
+
+import py5
+
+from peasy import PeasyCam
+
+def setup():
+    py5.size(500, 500, py5.P3D)
+    PeasyCam(py5.get_current_sketch(), 500)
+
+
+def draw():
+    py5.background(128)
+    py5.box(200)

py5_docs/Reference/api_en/Py5Tools_processing_installed_libraries.txt

@@ -11,3 +11,9 @@ processing_installed_libraries() -> list[str]
 List the Processing libraries stored in your computer's Processing library storage directory. These are all of the Processing libraries that have been installed using the [](py5tools_processing_download_library) function. To get the location of the library storage directory, use the [](py5tools_processing_library_storage_dir) function.
 
 Downloaded libraries will be saved in the Processing library storage directory. Use [](py5tools_processing_library_storage_dir) to get the specific location of the storage directory on your machine.
+
+@@ example
+import py5_tools
+
+print(py5_tools.processing.installed_libraries())
+# ['Camera 3D', 'PeasyCam', 'ColorBlindness']

py5_docs/Reference/api_en/Py5Tools_processing_library_storage_dir.txt

@@ -8,6 +8,10 @@ subcategory = None
 processing_library_storage_dir() -> Path
 
 @@ description
-Return the location of the Processing library storage directory. You should never need to manually edit files in this directory, but if for some reason you do, you'll first need to find it. By default, this will be `~/.cache/py5` on Linux and MacOS machines and `~/AppData/Local/py5` on Windows machines. These locations are similar to where other Python libraries store their data files. If you wish, set the `PY5_HOME` environment variable to move the storage directory to a location of your choosing.
+Return the location of the Processing library storage directory. You should never need to manually edit files in this directory, but if for some reason you do, you'll first need to find it. By default, this will be in `~/.cache/py5` on Linux and MacOS machines and `~/AppData/Local/py5` on Windows machines. These locations are similar to where other Python libraries store their data files. If you wish, set the `PY5_HOME` environment variable to move the storage directory to a location of your choosing.
 
-If you wish to add Java Jar files to py5's classpath, don't use this directory. Instead, put jars in a `jars` subdirectory (relative to the current working directory of your Python code) or set the `PY5_JARS` environment variable to the path of the directory you wish to use.
+If you wish to manually add Java Jar files to py5's classpath, don't use this directory. Instead, put jars in a `jars` subdirectory (relative to the current working directory of your Python code) or set the `PY5_JARS` environment variable to the path of the directory you wish to use.
+
+@@ example
+print(py5_tools.processing.library_storage_dir())
+# /home/jim/.cache/py5/processing-libraries

py5_docs/Reference/api_en/Py5Tools_processing_remove_library.txt

@@ -0,0 +1,19 @@
+@@ meta
+name = processing_remove_library()
+type = function
+category = processing
+subcategory = None
+
+@@ signatures
+processing_remove_library(library_name: str) -> None
+
+@@ variables
+library_name: str - name of Processing library
+
+@@ description
+Remove a previously downloaded and stored Processing library. These are the same libraries available to you in the Library Manager when you use the Processing Development Environment (PDE). You download and install Processing libraries with [](py5tools_processing_download_library). After this function removes a Processing library, it will no longer be available for you to use with py5.
+
+@@ example
+import py5_tools
+
+py5_tools.processing.remove_library("PeasyCam")

py5_resources/data/py5tools.csv

@@ -20,4 +20,5 @@ live_coding_activate,,,function,live_coding,,PYTHON,live_coding
 processing_library_storage_dir,,,function,processing,,PYTHON,processing
 processing_installed_libraries,,,function,processing,,PYTHON,processing
 processing_check_library,,,function,processing,,PYTHON,processing
-processing_download_library,,,function,processing,,PYTHON,processing
+processing_download_library,,,function,processing,,PYTHON,processing
+processing_remove_library,,,function,processing,,PYTHON,processing

py5_resources/py5_module/py5_tools/libraries.py

@@ -38,9 +38,9 @@ def __init__(self):
     def _load_data(self):
         response = requests.get(PROCESSING_LIBRARY_URL)
         if response.status_code != 200:
-            raise RuntimeError(
-                f"could not download data file at {PROCESSING_LIBRARY_URL}"
-            )
+            # Could not download data file. Perhaps the user is offline.
+            self._data = []
+            return
 
         blocks = [b for b in response.text.split("\n\n") if b.startswith("library")]
         data = [
@@ -102,7 +102,7 @@ def download_zip(self, dest, library_name=None, library_id=None):
 
         response = requests.get(download_url)
         if response.status_code != 200:
-            raise RuntimeError(f"could not download library at {download_url}")
+            raise RuntimeError(f"Could not download library at {download_url}")
 
         with zipfile.ZipFile(io.BytesIO(response.content)) as zf:
             jars = []

py5_resources/py5_module/py5_tools/processing.py

@@ -18,6 +18,7 @@
 #
 # *****************************************************************************
 import datetime as dt
+import shutil
 from pathlib import Path
 
 from .constants import PY5_HOME
@@ -114,7 +115,7 @@ def get_library(self, library_name):
         stored_info = self._load_library_info(library_name)
         if stored_info:
             if stored_info["version"] == info["version"]:
-                return
+                return stored_info
             print(f"Library {library_name} is outdated. Updating...")
 
         try:
@@ -128,6 +129,26 @@ def get_library(self, library_name):
             print(f"Failed to download library {library_name}: {e}")
             return
 
+    def remove_library(self, library_name):
+        """Remove a library from the storage directory.
+
+        Args:
+            library_name (str): The name of the library to remove.
+        """
+        info = self._load_library_info(library_name)
+        if info:
+            # Remove the library directory
+            lib_dir = STORAGE_DIR / info["dir"]
+            if lib_dir.exists():
+                shutil.rmtree(lib_dir)
+
+            # Remove the info file
+            info_file = STORAGE_DIR / f"{library_name}.txt"
+            if info_file.exists():
+                info_file.unlink()
+        else:
+            print(f"Library {library_name} not found in storage.")
+
 
 def library_storage_dir() -> Path:
     """$module_Py5Tools_processing_library_storage_dir"""
@@ -152,7 +173,7 @@ def check_library(library_name: str) -> bool:
     return _library_manager.check_library(library_name)
 
 
-def download_library(library_name: str) -> bool:
+def download_library(library_name: str) -> dict:
     """$module_Py5Tools_processing_download_library"""
     global _library_manager
     if _library_manager is None:
@@ -161,11 +182,21 @@ def download_library(library_name: str) -> bool:
     return _library_manager.get_library(library_name)
 
 
+def remove_library(library_name: str) -> None:
+    """$module_Py5Tools_processing_remove_library"""
+    global _library_manager
+    if _library_manager is None:
+        _library_manager = ProcessingLibraryManager()
+
+    _library_manager.remove_library(library_name)
+
+
 __all__ = [
     "check_library",
     "download_library",
     "installed_libraries",
     "library_storage_dir",
+    "remove_library",
 ]