zou 0.20.39__tar.gz → 0.20.40__tar.gz

{zou-0.20.39/zou.egg-info → zou-0.20.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zou
-Version: 0.20.39
+Version: 0.20.40
 Summary: API to store and manage the data of your animation production
 Home-page: https://zou.cg-wire.com
 Author: CG Wire
@@ -73,6 +73,7 @@ Requires-Dist: slackclient==2.9.4
 Requires-Dist: spdx-license-list==3.26.0
 Requires-Dist: sqlalchemy_utils==0.41.2
 Requires-Dist: sqlalchemy==2.0.40
+Requires-Dist: tabulate==0.9.0
 Requires-Dist: tomlkit==0.13.2
 Requires-Dist: ua-parser==1.0.1
 Requires-Dist: werkzeug==3.1.3

{zou-0.20.39 → zou-0.20.40}/setup.cfg

@@ -79,6 +79,7 @@ install_requires =
 	spdx-license-list==3.26.0
 	sqlalchemy_utils==0.41.2
 	sqlalchemy==2.0.40
+	tabulate==0.9.0
 	tomlkit==0.13.2
 	ua-parser==1.0.1
 	werkzeug==3.1.3

zou-0.20.40/zou/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.20.40"

{zou-0.20.39 → zou-0.20.40}/zou/app/api.py

@@ -1,13 +1,10 @@
 import os
 import sys
-import tomlkit
 import importlib
 import traceback
 
-from zou.app.utils import events
 from pathlib import Path
 
-
 from zou.app.blueprints.assets import blueprint as assets_blueprint
 from zou.app.blueprints.auth import blueprint as auth_blueprint
 from zou.app.blueprints.breakdown import blueprint as breakdown_blueprint
@@ -32,6 +29,9 @@ from zou.app.blueprints.user import blueprint as user_blueprint
 from zou.app.blueprints.edits import blueprint as edits_blueprint
 from zou.app.blueprints.concepts import blueprint as concepts_blueprint
 
+from zou.app.utils.plugins import PluginManifest
+from zou.app.utils import events
+
 
 def configure(app):
     """
@@ -98,30 +98,34 @@ def load_plugins(app):
     """
     Load plugins from the plugin folder.
     """
-    abs_plugin_path = os.path.abspath(app.config["PLUGIN_FOLDER"])
+    plugin_folder = app.config["PLUGIN_FOLDER"]
+    abs_plugin_path = os.path.abspath(plugin_folder)
     if abs_plugin_path not in sys.path:
         sys.path.insert(0, abs_plugin_path)
 
-    if os.path.exists(app.config["PLUGIN_FOLDER"]):
-        for plugin_id in os.listdir(app.config["PLUGIN_FOLDER"]):
+    if os.path.exists(plugin_folder):
+        for plugin_id in os.listdir(plugin_folder):
             try:
                 load_plugin(app, plugin_id)
                 app.logger.info(f"Plugin {plugin_id} loaded.")
-            except:
-                app.logger.error(f"Plugin {plugin_id} fails to load:")
-                app.logger.error(traceback.format_exc())
+            except ImportError as e:
+                app.logger.error(f"Plugin {plugin_id} failed to import: {e}")
+            except Exception as e:
+                app.logger.error(
+                    f"Plugin {plugin_id} failed to initialize: {e}"
+                )
+                app.logger.debug(traceback.format_exc())
 
     if abs_plugin_path in sys.path:
         sys.path.remove(abs_plugin_path)
 
 
 def load_plugin(app, plugin_id):
-    with open(
-        Path(app.config["PLUGIN_FOLDER"]).joinpath(plugin_id, "manifest.toml"),
-        "rb",
-    ) as manifest_file:
-        manifest = tomlkit.load(manifest_file)
+    plugin_path = Path(app.config["PLUGIN_FOLDER"]) / plugin_id
+    manifest = PluginManifest.from_file(plugin_path / "manifest.toml")
+
     plugin_module = importlib.import_module(plugin_id)
     if hasattr(plugin_module, "init_plugin"):
         plugin_module.init_plugin(app, manifest)
+
     return plugin_module

{zou-0.20.39 → zou-0.20.40}/zou/app/blueprints/crud/__init__.py

@@ -134,6 +134,8 @@ from zou.app.blueprints.crud.salary_scale import (
     SalaryScaleResource,
 )
 
+from zou.app.blueprints.crud.plugin import PluginResource, PluginsResource
+
 routes = [
     ("/data/persons", PersonsResource),
     ("/data/persons/<instance_id>", PersonResource),
@@ -218,6 +220,8 @@ routes = [
     ("/data/studios/<instance_id>", StudioResource),
     ("/data/salary-scales", SalaryScalesResource),
     ("/data/salary-scales/<instance_id>", SalaryScaleResource),
+    ("/data/plugins/<instance_id>", PluginResource),
+    ("/data/plugins", PluginsResource),
 ]
 
 blueprint = Blueprint("/data", "data")

zou-0.20.40/zou/app/services/plugins_service.py

@@ -0,0 +1,169 @@
+import zipfile
+import semver
+import shutil
+from pathlib import Path
+
+from zou.app import config, db
+from zou.app.models.plugin import Plugin
+from zou.app.utils.plugins import PluginManifest
+
+
+def install_plugin(path, force=False):
+    """
+    Install a plugin.
+    """
+    path = Path(path)
+    if not path.exists():
+        raise FileNotFoundError(f"Plugin path '{path}' does not exist.")
+
+    manifest = PluginManifest.from_plugin_path(path)
+    plugin = Plugin.query.filter_by(plugin_id=manifest.id).one_or_none()
+
+    try:
+        already_installed = False
+        if plugin:
+            current = semver.Version.parse(plugin.version)
+            new = semver.Version.parse(str(manifest.version))
+            if not force and new <= current:
+                raise ValueError(
+                    f"Plugin version {new} is not newer than {current}."
+                )
+            plugin.update_no_commit(manifest.to_model_dict())
+            already_installed = True
+        else:
+            plugin = Plugin.create_no_commit(**manifest.to_model_dict())
+
+        install_plugin_files(manifest.id, path, already_installed)
+    except Exception:
+        uninstall_plugin_files(manifest.id)
+        db.session.rollback()
+        db.session.remove()
+        raise
+
+    Plugin.commit()
+    return plugin.serialize()
+
+
+def install_plugin_files(plugin_id, path, already_installed=False):
+    """
+    Install plugin files.
+    """
+    path = Path(path)
+    plugin_path = Path(config.PLUGIN_FOLDER) / plugin_id
+    if already_installed and plugin_path.exists():
+        shutil.rmtree(plugin_path)
+
+    plugin_path.mkdir(parents=True, exist_ok=True)
+
+    if path.is_dir():
+        shutil.copytree(path, plugin_path, dirs_exist_ok=True)
+    elif zipfile.is_zipfile(path):
+        shutil.unpack_archive(path, plugin_path, format="zip")
+    else:
+        raise ValueError(
+            f"Plugin path '{path}' is not a valid zip file or a directory."
+        )
+
+    return plugin_path
+
+
+def uninstall_plugin_files(plugin_id):
+    """
+    Uninstall plugin files.
+    """
+    plugin_path = Path(config.PLUGIN_FOLDER) / plugin_id
+    if plugin_path.exists():
+        shutil.rmtree(plugin_path)
+        return True
+    return False
+
+
+def uninstall_plugin(plugin_id):
+    """
+    Uninstall a plugin.
+    """
+    installed = uninstall_plugin_files(plugin_id)
+    plugin = Plugin.query.filter_by(plugin_id=plugin_id).one_or_none()
+    if plugin is not None:
+        installed = True
+        plugin.delete()
+
+    if not installed:
+        raise ValueError(f"Plugin '{plugin_id}' is not installed.")
+    return True
+
+
+def create_plugin_skeleton(
+    path,
+    id,
+    name,
+    description=None,
+    version=None,
+    maintainer=None,
+    website=None,
+    license=None,
+    force=False,
+):
+    plugin_template_path = (
+        Path(__file__).parent.parent.parent / "plugin_template"
+    )
+    plugin_path = Path(path) / id
+
+    if plugin_path.exists():
+        if force:
+            shutil.rmtree(plugin_path)
+        else:
+            raise FileExistsError(
+                f"Plugin '{id}' already exists in {plugin_path}."
+            )
+
+    shutil.copytree(plugin_template_path, plugin_path)
+
+    manifest = PluginManifest.from_file(plugin_path / "manifest.toml")
+
+    manifest.id = id
+    manifest.name = name
+    if description:
+        manifest.description = description
+    if version:
+        manifest.version = version
+    if maintainer:
+        manifest.maintainer = maintainer
+    if website:
+        manifest.website = website
+    if license:
+        manifest.license = license
+
+    manifest.validate()
+    manifest.write_to_path(plugin_path)
+
+    return plugin_path
+
+
+def create_plugin_package(path, output_path, force=False):
+    """
+    Create a plugin package.
+    """
+    path = Path(path)
+    if not path.exists():
+        raise FileNotFoundError(f"Plugin path '{path}' does not exist.")
+
+    manifest = PluginManifest.from_plugin_path(path)
+
+    output_path = Path(output_path)
+    if not output_path.suffix == ".zip":
+        output_path /= f"{manifest.id}-{manifest.version}.zip"
+    if output_path.exists():
+        if force:
+            output_path.unlink()
+        else:
+            raise FileExistsError(
+                f"Output path '{output_path}' already exists."
+            )
+
+    output_path = shutil.make_archive(
+        output_path.with_suffix(""),
+        "zip",
+        path,
+    )
+    return output_path

{zou-0.20.39 → zou-0.20.40}/zou/app/utils/commands.py

@@ -5,8 +5,10 @@ import datetime
 import tempfile
 import sys
 import shutil
+import click
+import orjson as json
 
-
+from tabulate import tabulate
 from ldap3 import Server, Connection, ALL, NTLM, SIMPLE
 from zou.app.utils import thumbnail as thumbnail_utils, auth
 from zou.app.stores import auth_tokens_store, file_store, queue_store
@@ -27,6 +29,7 @@ from zou.app.services import (
 from zou.app.models.person import Person
 from zou.app.models.preview_file import PreviewFile
 from zou.app.models.task import Task
+from zou.app.models.plugin import Plugin
 from sqlalchemy.sql.expression import not_
 
 from zou.app.services.exception import (
@@ -823,3 +826,50 @@ def renormalize_movie_preview_files(
                             f"Renormalization of preview file {preview_file_id} failed: {e}"
                         )
                         continue
+
+
+def list_plugins(output_format, verbose, filter_field, filter_value):
+    with app.app_context():
+        query = Plugin.query
+
+        # Apply filter if needed
+        if filter_field and filter_value:
+            if filter_field == "maintainer":
+                query = query.filter(
+                    Plugin.maintainer_name.ilike(f"%{filter_value}%")
+                )
+            else:
+                model_field = getattr(Plugin, filter_field)
+                query = query.filter(model_field.ilike(f"%{filter_value}%"))
+
+        plugins = query.order_by(Plugin.name).all()
+
+        if not plugins:
+            click.echo("No plugins found matching the criteria.")
+            return
+
+        plugin_list = []
+        for plugin in plugins:
+            maintainer = (
+                f"{plugin.maintainer_name} <{plugin.maintainer_email}>"
+                if plugin.maintainer_email
+                else plugin.maintainer_name
+            )
+            plugin_data = {
+                "Plugin ID": plugin.plugin_id,
+                "Name": plugin.name,
+                "Version": plugin.version,
+                "Maintainer": maintainer,
+                "License": plugin.license,
+            }
+            if verbose:
+                plugin_data["Description"] = plugin.description or "-"
+                plugin_data["Website"] = plugin.website or "-"
+            plugin_list.append(plugin_data)
+
+        if output_format == "table":
+            headers = plugin_list[0].keys()
+            rows = [p.values() for p in plugin_list]
+            click.echo(tabulate(rows, headers, tablefmt="fancy_grid"))
+        elif output_format == "json":
+            click.echo(json.dumps(plugin_list, indent=2, ensure_ascii=False))

zou-0.20.40/zou/app/utils/plugins.py

@@ -0,0 +1,88 @@
+import tomlkit
+import semver
+import email.utils
+import spdx_license_list
+import zipfile
+
+from pathlib import Path
+from collections.abc import MutableMapping
+
+
+class PluginManifest(MutableMapping):
+    def __init__(self, data):
+        super().__setattr__("data", data)
+        self.validate()
+
+    @classmethod
+    def from_plugin_path(cls, path):
+        path = Path(path)
+        if path.is_dir():
+            return cls.from_file(path / "manifest.toml")
+        elif zipfile.is_zipfile(path):
+            with zipfile.ZipFile(path) as z:
+                with z.open("manifest.toml") as f:
+                    data = tomlkit.load(f)
+            return cls(data)
+        else:
+            raise ValueError(f"Invalid plugin path: {path}")
+
+    @classmethod
+    def from_file(cls, path):
+        with open(path, "rb") as f:
+            data = tomlkit.load(f)
+        return cls(data)
+
+    def write_to_path(self, path):
+        path = Path(path)
+        with open(path / "manifest.toml", "w", encoding="utf-8") as f:
+            tomlkit.dump(self.data, f)
+
+    def validate(self):
+        semver.Version.parse(str(self.data["version"]))
+        spdx_license_list.LICENSES[self.data["license"]]
+        if "maintainer" in self.data:
+            name, email_addr = email.utils.parseaddr(self.data["maintainer"])
+            self.data["maintainer_name"] = name
+            self.data["maintainer_email"] = email_addr
+
+    def to_model_dict(self):
+        return {
+            "plugin_id": self.data["id"],
+            "name": self.data["name"],
+            "description": self.data.get("description"),
+            "version": str(self.data["version"]),
+            "maintainer_name": self.data.get("maintainer_name"),
+            "maintainer_email": self.data.get("maintainer_email"),
+            "website": self.data.get("website"),
+            "license": self.data["license"],
+        }
+
+    def __getitem__(self, key):
+        return self.data[key]
+
+    def __setitem__(self, key, value):
+        self.data[key] = value
+
+    def __delitem__(self, key):
+        del self.data[key]
+
+    def __iter__(self):
+        return iter(self.data)
+
+    def __len__(self):
+        return len(self.data)
+
+    def __repr__(self):
+        return f"<PluginManifest {self.data!r}>"
+
+    def __getattr__(self, attr):
+        try:
+            return self.data[attr]
+        except KeyError:
+            raise AttributeError(f"'PluginManifest' has no attribute '{attr}'")
+
+    def __setattr__(self, attr, value):
+        if attr == "data":
+            super().__setattr__(attr, value)
+        else:
+            self.data[attr] = value

{zou-0.20.39 → zou-0.20.40}/zou/cli.py

@@ -9,12 +9,13 @@ import traceback
 from sqlalchemy.exc import IntegrityError
 
 from zou.app.utils import dbhelpers, auth, commands
-from zou.app.services import persons_service, auth_service, plugin_service
+from zou.app.services import persons_service, auth_service, plugins_service
 from zou.app.services.exception import (
     IsUserLimitReachedException,
     PersonNotFoundException,
     TwoFactorAuthenticationNotEnabledException,
 )
+
 from zou.app import app, config
 
 from zou import __file__ as root_path
@@ -659,7 +660,7 @@ def install_plugin(path, force=False):
     Install a plugin.
     """
     with app.app_context():
-        plugin_service.install_plugin(path, force)
+        plugins_service.install_plugin(path, force)
     print(f"Plugin {path} installed. Restart the server to apply changes.")
 
 
@@ -673,7 +674,7 @@ def uninstall_plugin(id):
     Uninstall a plugin.
     """
     with app.app_context():
-        plugin_service.uninstall_plugin(id)
+        plugins_service.uninstall_plugin(id)
     print(f"Plugin {id} uninstalled.")
 
 
@@ -737,7 +738,7 @@ def create_plugin_skeleton(
     """
     Create a plugin skeleton.
     """
-    plugin_path = plugin_service.create_plugin_skeleton(
+    plugin_path = plugins_service.create_plugin_skeleton(
         path,
         id,
         name,
@@ -751,5 +752,64 @@ def create_plugin_skeleton(
     print(f"Plugin skeleton created in '{plugin_path}'.")
 
 
+@cli.command()
+@click.option(
+    "--path",
+    required=True,
+)
+@click.option(
+    "--output-path",
+    required=True,
+)
+@click.option(
+    "--force",
+    is_flag=True,
+    default=False,
+    show_default=True,
+)
+def create_plugin_package(
+    path,
+    output_path,
+    force=False,
+):
+    """
+    Create a plugin package.
+    """
+    plugin_path = plugins_service.create_plugin_package(
+        path, output_path, force
+    )
+    print(f"Plugin package created in '{plugin_path}'.")
+
+
+@cli.command()
+@click.option(
+    "--format",
+    "output_format",
+    type=click.Choice(["table", "json"], case_sensitive=False),
+    default="table",
+    show_default=True,
+    help="Output format: table or json.",
+)
+@click.option(
+    "--verbose",
+    is_flag=True,
+    default=False,
+    help="Show more plugin information.",
+)
+@click.option(
+    "--filter-field",
+    type=click.Choice(
+        ["plugin_id", "name", "maintainer", "license"], case_sensitive=False
+    ),
+    help="Field to filter by.",
+)
+@click.option("--filter-value", type=str, help="Value to search in the field.")
+def list_plugins(output_format, verbose, filter_field, filter_value):
+    """
+    List installed plugins.
+    """
+    commands.list_plugins(output_format, verbose, filter_field, filter_value)
+
+
 if __name__ == "__main__":
     cli()

{zou-0.20.39 → zou-0.20.40/zou.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zou
-Version: 0.20.39
+Version: 0.20.40
 Summary: API to store and manage the data of your animation production
 Home-page: https://zou.cg-wire.com
 Author: CG Wire
@@ -73,6 +73,7 @@ Requires-Dist: slackclient==2.9.4
 Requires-Dist: spdx-license-list==3.26.0
 Requires-Dist: sqlalchemy_utils==0.41.2
 Requires-Dist: sqlalchemy==2.0.40
+Requires-Dist: tabulate==0.9.0
 Requires-Dist: tomlkit==0.13.2
 Requires-Dist: ua-parser==1.0.1
 Requires-Dist: werkzeug==3.1.3

{zou-0.20.39 → zou-0.20.40}/zou.egg-info/SOURCES.txt

@@ -223,7 +223,7 @@ zou/app/services/news_service.py
 zou/app/services/notifications_service.py
 zou/app/services/persons_service.py
 zou/app/services/playlists_service.py
-zou/app/services/plugin_service.py
+zou/app/services/plugins_service.py
 zou/app/services/preview_files_service.py
 zou/app/services/projects_service.py
 zou/app/services/scenes_service.py
@@ -262,6 +262,7 @@ zou/app/utils/git.py
 zou/app/utils/logs.py
 zou/app/utils/monitoring.py
 zou/app/utils/permissions.py
+zou/app/utils/plugins.py
 zou/app/utils/query.py
 zou/app/utils/redis.py
 zou/app/utils/remote_job.py

{zou-0.20.39 → zou-0.20.40}/zou.egg-info/requires.txt

@@ -48,6 +48,7 @@ slackclient==2.9.4
 spdx-license-list==3.26.0
 sqlalchemy_utils==0.41.2
 sqlalchemy==2.0.40
+tabulate==0.9.0
 tomlkit==0.13.2
 ua-parser==1.0.1
 werkzeug==3.1.3

zou-0.20.39/zou/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.20.39"