zou 1.0.4__py3-none-any.whl → 1.0.5__py3-none-any.whl

zou/app/services/plugins_service.py

@@ -1,4 +1,5 @@
 import semver
+import shutil
 from pathlib import Path
 
 from zou.app import config, db
@@ -9,16 +10,32 @@ from zou.app.utils.plugins import (
     downgrade_plugin_migrations,
     uninstall_plugin_files,
     install_plugin_files,
+    clone_git_repo,
 )
 
 
 def install_plugin(path, force=False):
     """
-    Install a plugin.
+    Install a plugin: create folder, copy files, run migrations.
+    Supports local paths, zip files, and git repository URLs.
     """
-    path = Path(path)
-    if not path.exists():
-        raise FileNotFoundError(f"Plugin path '{path}' does not exist.")
+    is_git_url = (
+        path.startswith("http://")
+        or path.startswith("https://")
+        or path.startswith("git://")
+        or path.startswith("ssh://")
+        or path.startswith("git@")
+    )
+
+    temp_dir = None
+    if is_git_url:
+        cloned_path = clone_git_repo(path)
+        temp_dir = cloned_path.parent
+        path = cloned_path
+    else:
+        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()
@@ -27,32 +44,46 @@ def install_plugin(path, force=False):
         if plugin:
             current = semver.Version.parse(plugin.version)
             new = semver.Version.parse(str(manifest.version))
+            print(
+                f"[Plugins] Upgrading plugin {manifest.id} from version {current} to {new}..."
+            )
             if not force and new <= current:
-                raise ValueError(
-                    f"Plugin version {new} is not newer than {current}."
-                )
+                print(f"⚠️  Plugin version {new} is not newer than {current}.")
             plugin.update_no_commit(manifest.to_model_dict())
+            print(f"[Plugins] Plugin {manifest.id} upgraded.")
         else:
+            print(f"[Plugins] Installing plugin {manifest.id}...")
             plugin = Plugin.create_no_commit(**manifest.to_model_dict())
+            print(f"[Plugins] Plugin {manifest.id} installed.")
 
+        print(f"[Plugins] Running database migrations for {manifest.id}...")
         plugin_path = install_plugin_files(
             path, Path(config.PLUGIN_FOLDER) / manifest.id
         )
         run_plugin_migrations(plugin_path, plugin)
+        print(f"[Plugins] Database migrations for {manifest.id} applied.")
     except Exception:
-        uninstall_plugin_files(manifest.id)
-        db.session.rollback()
-        db.session.remove()
+        print(
+            f"❌ [Plugins] An error occurred while installing/updating {manifest.id}..."
+        )
         raise
 
     Plugin.commit()
+    print_added_routes(plugin, plugin_path)
+
+    if is_git_url:
+        if temp_dir and temp_dir.exists():
+            shutil.rmtree(temp_dir)
+
     return plugin.serialize()
 
 
 def uninstall_plugin(plugin_id):
     """
-    Uninstall a plugin.
+    Uninstall a plugin: downgrade migrations, remove files,
+    delete from database and remove folder.
     """
+    print(f"[Plugins] Uninstalling plugin {plugin_id}...")
     plugin_path = Path(config.PLUGIN_FOLDER) / plugin_id
     downgrade_plugin_migrations(plugin_path)
     installed = uninstall_plugin_files(plugin_path)
@@ -63,4 +94,45 @@ def uninstall_plugin(plugin_id):
 
     if not installed:
         raise ValueError(f"Plugin '{plugin_id}' is not installed.")
+
+    print(f"[Plugins] Plugin {plugin_id} uninstalled.")
     return True
+
+
+def print_added_routes(plugin, plugin_path):
+    """
+    Print the added routes for a plugin.
+    """
+    import importlib
+    import sys
+
+    print(f"[Plugins] Routes added by {plugin.plugin_id}:")
+    plugin_path = Path(plugin_path)
+
+    plugin_folder = plugin_path.parent
+    abs_plugin_path = str(plugin_folder.absolute())
+    if abs_plugin_path not in sys.path:
+        sys.path.insert(0, abs_plugin_path)
+
+    try:
+        plugin_module = importlib.import_module(plugin.plugin_id)
+        if hasattr(plugin_module, "routes"):
+            routes = plugin_module.routes
+            for route in routes:
+                print(f"  - /plugins/{plugin.plugin_id}{route[0]}")
+        else:
+            print("  (No routes variable found in plugin)")
+    except ImportError as e:
+        print(f"  ⚠️  Could not import plugin module: {e}")
+    finally:
+        if abs_plugin_path in sys.path:
+            sys.path.remove(abs_plugin_path)
+
+    print("--------------------------------")
+
+
+def get_plugins():
+    """
+    Get all plugins.
+    """
+    return [plugin.present() for plugin in Plugin.query.all()]

zou/app/services/schedule_service.py

@@ -55,7 +55,8 @@ def get_task_types_schedule_items(project_id):
     task_types = [
         task_type
         for task_type in task_types
-        if task_type["for_entity"] in ["Asset", "Shot"]
+        if task_type["for_entity"]
+        in ["Asset", "Shot", "Sequence", "Episode", "Edit"]
     ]
     task_type_map = base_service.get_model_map_from_array(task_types)
     schedule_items = set(

zou/app/services/tasks_service.py

@@ -1815,7 +1815,7 @@ def reset_task_data(task_id):
         if task_status_is_wip and real_start_date is None:
             real_start_date = comment.created_at
 
-        if task_status_is_feedback_request:
+        if task_status_is_feedback_request and end_date is None:
             end_date = comment.created_at
 
         print("ok", task_status_is_done)

zou/app/services/user_service.py

@@ -15,6 +15,8 @@ from zou.app.models.search_filter_group import SearchFilterGroup
 from zou.app.models.task import Task
 from zou.app.models.task_type import TaskType
 
+from zou.app.services import plugins_service
+
 
 from zou.app.services import (
     assets_service,
@@ -1670,6 +1672,7 @@ def get_context():
         "search_filters": get_filters(),
         "search_filter_groups": get_filter_groups(),
         "preview_background_files": files_service.get_preview_background_files(),
+        "plugins": plugins_service.get_plugins(),
     }
 
     if permissions.has_admin_permissions():

zou/app/utils/commands.py

@@ -848,7 +848,6 @@ 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(
@@ -881,6 +880,7 @@ def list_plugins(output_format, verbose, filter_field, filter_value):
             if verbose:
                 plugin_data["Description"] = plugin.description or "-"
                 plugin_data["Website"] = plugin.website or "-"
+                plugin_data["Icon"] = plugin.icon or "-"
                 plugin_data["Revision"] = plugin.revision or "-"
                 plugin_data["Installation Date"] = plugin.created_at
                 plugin_data["Last Update"] = plugin.updated_at

zou/app/utils/plugins.py

@@ -1,5 +1,3 @@
-import tomlkit
-import semver
 import email.utils
 import spdx_license_list
 import zipfile
@@ -7,17 +5,52 @@ import importlib
 import importlib.util
 import sys
 import os
+import tomlkit
 import traceback
+import semver
 import shutil
+import subprocess
+import tempfile
 
-from pathlib import Path
-from flask import current_app
 from alembic import command
 from alembic.config import Config
+from collections.abc import MutableMapping
+from flask import Blueprint, current_app
+from flask_restful import Resource
+from pathlib import Path
 
+from zou.app.utils.api import configure_api_from_blueprint
 
-from pathlib import Path
-from collections.abc import MutableMapping
+from flask import send_from_directory, abort, current_app
+
+
+class StaticResource(Resource):
+
+    plugin_id = None
+
+    def get(self, filename="index.html"):
+
+        print(self.plugin_id)
+        static_folder = (
+            Path(current_app.config.get("PLUGIN_FOLDER", "plugins"))
+            / self.plugin_id
+            / "frontend"
+            / "dist"
+        )
+
+        if filename == "":
+            filename = "index.html"
+
+        file_path = static_folder / filename
+        if not file_path.exists() or not file_path.is_file():
+            abort(404)
+
+        if filename == "":
+            filename = "index.html"
+
+        return send_from_directory(
+            str(static_folder), filename, conditional=True, max_age=0
+        )
 
 
 class PluginManifest(MutableMapping):
@@ -57,6 +90,11 @@ class PluginManifest(MutableMapping):
             self.data["maintainer_name"] = name
             self.data["maintainer_email"] = email_addr
 
+        if "frontend_project_enabled" not in self.data:
+            self.data["frontend_project_enabled"] = False
+        if "frontend_studio_enabled" not in self.data:
+            self.data["frontend_studio_enabled"] = False
+
     def to_model_dict(self):
         return {
             "plugin_id": self.data["id"],
@@ -67,6 +105,13 @@ class PluginManifest(MutableMapping):
             "maintainer_email": self.data.get("maintainer_email"),
             "website": self.data.get("website"),
             "license": self.data["license"],
+            "frontend_project_enabled": self.data.get(
+                "frontend_project_enabled", False
+            ),
+            "frontend_studio_enabled": self.data.get(
+                "frontend_studio_enabled", False
+            ),
+            "icon": self.data.get("icon", ""),
         }
 
     def __getitem__(self, key):
@@ -106,10 +151,16 @@ def load_plugin(app, plugin_path, init_plugin=True):
     """
     plugin_path = Path(plugin_path)
     manifest = PluginManifest.from_plugin_path(plugin_path)
-
     plugin_module = importlib.import_module(manifest["id"])
-    if init_plugin and hasattr(plugin_module, "init_plugin"):
-        plugin_module.init_plugin(app, manifest)
+
+    if not hasattr(plugin_module, "routes"):
+        raise Exception(f"Plugin {manifest['id']} has no routes.")
+
+    routes = plugin_module.routes
+    add_static_routes(manifest, routes)
+    blueprint = Blueprint(manifest["id"], manifest["id"])
+    configure_api_from_blueprint(blueprint, routes)
+    app.register_blueprint(blueprint, url_prefix=f"/plugins/{manifest['id']}")
 
     return plugin_module
 
@@ -270,6 +321,7 @@ def create_plugin_skeleton(
     maintainer=None,
     website=None,
     license=None,
+    icon=None,
     force=False,
 ):
     plugin_template_path = (
@@ -301,7 +353,8 @@ def create_plugin_skeleton(
         manifest.website = website
     if license:
         manifest.license = license
-
+    if icon:
+        manifest.icon = icon
     manifest.validate()
     manifest.write_to_path(plugin_path)
 
@@ -338,3 +391,54 @@ def uninstall_plugin_files(plugin_path):
         shutil.rmtree(plugin_path)
         return True
     return False
+
+
+def clone_git_repo(git_url, temp_dir=None):
+    """
+    Clone a git repository to a temporary directory.
+    Returns the path to the cloned directory.
+    """
+    if temp_dir is None:
+        temp_dir = tempfile.mkdtemp(prefix="zou_plugin_")
+
+    temp_dir = Path(temp_dir)
+    repo_name = git_url.rstrip("/").split("/")[-1].replace(".git", "")
+    clone_path = temp_dir / repo_name
+
+    print(f"[Plugins] Cloning {git_url}...")
+
+    try:
+        subprocess.run(
+            ["git", "clone", git_url, str(clone_path)],
+            check=True,
+            capture_output=True,
+            timeout=300,
+        )
+        print(f"[Plugins] Successfully cloned {git_url}")
+        return clone_path
+    except subprocess.CalledProcessError as e:
+        error_msg = e.stderr.decode() if e.stderr else str(e)
+        raise ValueError(f"Failed to clone repository {git_url}: {error_msg}")
+    except FileNotFoundError:
+        raise ValueError(
+            "git is not available. Please install git to clone repositories."
+        )
+
+
+def add_static_routes(manifest, routes):
+    """
+    Add static routes to the manifest.
+    """
+
+    class PluginStaticResource(StaticResource):
+
+        def __init__(self):
+            self.plugin_id = manifest.id
+            super().__init__()
+
+    if (
+        manifest["frontend_project_enabled"]
+        or manifest["frontend_studio_enabled"]
+    ):
+        routes.append((f"/frontend/<path:filename>", PluginStaticResource))
+        routes.append((f"/frontend", PluginStaticResource))

zou/cli.py

@@ -660,6 +660,7 @@ def renormalize_movie_preview_files(
 @click.option(
     "--path",
     required=True,
+    help="Plugin path: local directory, zip file, or git repository URL",
 )
 @click.option(
     "--force",
@@ -669,11 +670,12 @@ def renormalize_movie_preview_files(
 )
 def install_plugin(path, force=False):
     """
-    Install a plugin.
+    Install a plugin and apply the migrations.
+    Supports local paths, zip files, and git repository URLs.
     """
     with app.app_context():
         plugins_service.install_plugin(path, force)
-    print(f"Plugin {path} installed. Restart the server to apply changes.")
+    print(f"✅ Plugin {path} installed. Restart the server to apply changes.")
 
 
 @cli.command()
@@ -687,7 +689,7 @@ def uninstall_plugin(id):
     """
     with app.app_context():
         plugins_service.uninstall_plugin(id)
-    print(f"Plugin {id} uninstalled.")
+    print(f"Plugin {id} uninstalled. Restart the server to apply changes.")
 
 
 @cli.command()
@@ -730,6 +732,12 @@ def uninstall_plugin(id):
     default="GPL-3.0-only",
     show_default=True,
 )
+@click.option(
+    "--icon",
+    help="Plugin icon (lucide-vue icon name).",
+    default=None,
+    show_default=True,
+)
 @click.option(
     "--force",
     is_flag=True,
@@ -745,10 +753,11 @@ def create_plugin_skeleton(
     maintainer,
     website,
     license,
+    icon,
     force=False,
 ):
     """
-    Create a plugin skeleton.
+    Create a plugin template in the given path.
     """
     plugin_path = plugin_utils.create_plugin_skeleton(
         path,
@@ -759,9 +768,10 @@ def create_plugin_skeleton(
         maintainer,
         website,
         license,
+        icon,
         force,
     )
-    print(f"Plugin skeleton created in '{plugin_path}'.")
+    print(f"Plugin file tree skeleton created in '{plugin_path}'.")
 
 
 @cli.command()

zou/migrations/versions/12208e50bf18_add_json_data_field_to_preview_files.py

@@ -0,0 +1,38 @@
+"""add JSON data field to preview files
+
+Revision ID: 12208e50bf18
+Revises: a0f668430352
+Create Date: 2025-12-19 11:27:57.477880
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+import sqlalchemy_utils
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "12208e50bf18"
+down_revision = "a0f668430352"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("preview_file", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "data", postgresql.JSONB(astext_type=sa.Text()), nullable=True
+            )
+        )
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("preview_file", schema=None) as batch_op:
+        batch_op.drop_column("data")
+
+    # ### end Alembic commands ###

zou/migrations/versions/35ebb38695cd_add_icon_field_to_plugins.py

@@ -0,0 +1,36 @@
+"""add icon field to plugins
+
+Revision ID: 35ebb38695cd
+Revises: 9a9df20ea5a7
+Create Date: 2025-12-24 11:39:42.229109
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+import sqlalchemy_utils
+
+
+# revision identifiers, used by Alembic.
+revision = "35ebb38695cd"
+down_revision = "9a9df20ea5a7"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("plugin", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column("icon", sa.String(length=255), nullable=True)
+        )
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("plugin", schema=None) as batch_op:
+        batch_op.drop_column("icon")
+
+    # ### end Alembic commands ###

zou/migrations/versions/9a9df20ea5a7_add_frontend_options_to_plugins.py

@@ -0,0 +1,40 @@
+"""add frontend options to plugins
+
+Revision ID: 9a9df20ea5a7
+Revises: 12208e50bf18
+Create Date: 2025-12-23 00:47:50.621868
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+import sqlalchemy_utils
+
+
+# revision identifiers, used by Alembic.
+revision = "9a9df20ea5a7"
+down_revision = "12208e50bf18"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("plugin", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column("frontend_project_enabled", sa.Boolean(), nullable=True)
+        )
+        batch_op.add_column(
+            sa.Column("frontend_studio_enabled", sa.Boolean(), nullable=True)
+        )
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("plugin", schema=None) as batch_op:
+        batch_op.drop_column("frontend_studio_enabled")
+        batch_op.drop_column("frontend_project_enabled")
+
+    # ### end Alembic commands ###

zou/migrations/versions/a0f668430352_add_created_by_field_to_playlists.py

@@ -5,6 +5,7 @@ Revises: a1b2c3d4e5f6
 Create Date: 2025-12-03 12:10:52.626583
 
 """
+
 from alembic import op
 import sqlalchemy as sa
 import sqlalchemy_utils
@@ -12,25 +13,32 @@ import sqlalchemy_utils
 import uuid
 
 # revision identifiers, used by Alembic.
-revision = 'a0f668430352'
-down_revision = 'a1b2c3d4e5f6'
+revision = "a0f668430352"
+down_revision = "a1b2c3d4e5f6"
 branch_labels = None
 depends_on = None
 
 
 def upgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    with op.batch_alter_table('playlist', schema=None) as batch_op:
-        batch_op.add_column(sa.Column('created_by', sqlalchemy_utils.types.uuid.UUIDType(binary=False), default=uuid.uuid4, nullable=True))
-        batch_op.create_foreign_key(None, 'person', ['created_by'], ['id'])
+    with op.batch_alter_table("playlist", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "created_by",
+                sqlalchemy_utils.types.uuid.UUIDType(binary=False),
+                default=uuid.uuid4,
+                nullable=True,
+            )
+        )
+        batch_op.create_foreign_key(None, "person", ["created_by"], ["id"])
 
     # ### end Alembic commands ###
 
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    with op.batch_alter_table('playlist', schema=None) as batch_op:
-        batch_op.drop_constraint(None, type_='foreignkey')
-        batch_op.drop_column('created_by')
+    with op.batch_alter_table("playlist", schema=None) as batch_op:
+        batch_op.drop_constraint(None, type_="foreignkey")
+        batch_op.drop_column("created_by")
 
     # ### end Alembic commands ###

zou/plugin_template/__init__.py

@@ -1,18 +1,7 @@
-from . import routes
-from flask import Blueprint
-from zou.app.utils.api import configure_api_from_blueprint
+from . import resources
 
 
-def init_plugin(app, manifest):
-    """
-    Init the plugin.
-    """
-    app.logger.info("Loading plugin...")
-    routes_tuples = [(f"/hello-world", routes.HelloWorld)]
-
-    blueprint = Blueprint(manifest["id"], manifest["id"])
-    configure_api_from_blueprint(blueprint, routes_tuples)
-    app.register_blueprint(blueprint, url_prefix=f"/{manifest['id']}")
+routes = [(f"/hello-world", resources.HelloWorld)]
 
 
 def pre_install(manifest):

zou/plugin_template/migrations/env.py

@@ -1,11 +1,14 @@
 import importlib.util
 import logging
 import sys
+
 from alembic import context
 from sqlalchemy import create_engine, pool
+
 from pathlib import Path
 from logging.config import fileConfig
 
+from zou.app import db
 from zou.app.utils.plugins import PluginManifest
 
 plugin_path = Path(__file__).resolve().parents[1]
@@ -18,6 +21,12 @@ module = importlib.util.module_from_spec(spec)
 sys.modules[module_name] = module
 spec.loader.exec_module(module)
 
+# Add zou tables
+module.plugin_metadata.tables = {
+    **db.metadata.tables,
+    **module.plugin_metadata.tables,
+}
+
 # Database URL (passed by Alembic)
 config = context.config
 url = config.get_main_option("sqlalchemy.url")

zou/plugin_template/models.py

@@ -10,8 +10,8 @@ PluginBase = declarative_base(metadata=plugin_metadata)
 
 class Count(PluginBase, BaseMixin, SerializerMixin):
     """
-    Describe a plugin.
+    A simple model to keep track of a count.
     """
 
-    __tablename__ = "toto_count"
+    __tablename__ = "hello_count"
     count = Column(Integer, nullable=False, default=0)

zou/plugin_template/{routes.py → resources.py}

@@ -1,8 +1,12 @@
 from flask_restful import Resource
+from flask_jwt_extended import jwt_required
+
 from .models import Count
 
 
 class HelloWorld(Resource):
+
+    @jwt_required()
     def get(self):
         if not Count.query.first():
             c = Count.create()