Feature/pinning file support

Docs/Ayon_Docs/Dev_Docs.md

@@ -18,9 +18,43 @@ Most important Locations.
 
 ### Pinning Support.
 
-The Ayon Usd resolver has a feature we call pinning support. This allows storing
-the current state of an Usd stage in a file to load the data quickly and without
-server interaction on a Farm or any distributed system that might overwhelm or
-impact the server performance.
+`Standalone/Usd/pinning/pinning_file_helper.py`
 
-The rest of this can be found in the pinning support Branch
+The Ayon Usd resolver has a feature we call pinning support.\
+This allows storing the current resolver state for an Usd stage in a file to
+load the frozen stage without server interaction.
+
+`generate_pinning_file`\
+creates a pinning file JSON from a given USD stage
+
+```py
+def generate_pinning_file(
+    entry_usd: str, root_info: Dict[str, str], pinning_file_path: str
+):
+```
+
+Example Code:
+
+```py
+import os
+import ayon_api
+from ayon_usd.standalone.usd.pinning import pinning_file_helper
+
+
+in_usd_file = "/path/to/usd/file.usd"
+root_info = ayon_api.get_project_roots_for_site(os.environ.get("AYON_PROJECT_NAME"))
+
+pinning_file_helper.generate_pinning_file(in_usd_file, root_info, "/path/to/output_file.json")
+```
+
+`in_usd_file` can be everything that the AyonUsdResolver can resolve including
+an URI its just important to know that what ever you use as the input must be
+the input when you load the usd.\
+in other words: if you use an uri to generate the pinning file you need to open
+the stage with the same uri, if you use an file path you will need to do the
+same.\
+it is generally advised to use an URI as they will never have any system
+specific data in them.\
+The generated pinning file also has a key that will tell you what entry point as
+used to generate the pinning file. you can simply read out this key and use it
+to open a stage with the pinning file `ayon_pinning_data_entry_sceene`

client/ayon_usd/addon.py

@@ -4,7 +4,7 @@
 import os
 from datetime import datetime, timezone
 
-from ayon_core.addon import AYONAddon, ITrayAddon 
+from ayon_core.addon import AYONAddon, ITrayAddon, IPluginPaths
 
 from ayon_core import style
 
@@ -14,8 +14,10 @@
 from .ayon_bin_client.ayon_bin_distro.work_handler import worker
 from .ayon_bin_client.ayon_bin_distro.util import zip
 
+USD_ADDON_ROOT = os.path.dirname(os.path.abspath(__file__))
 
-class USDAddon(AYONAddon, ITrayAddon):
+
+class USDAddon(AYONAddon, ITrayAddon, IPluginPaths):
     """Addon to add USD Support to AYON.
 
     Addon can also skip distribution of binaries from server and can
@@ -34,6 +36,10 @@ def tray_init(self):
 
     def initialize(self, module_settings):
         """Initialize USD Addon."""
+        if not module_settings["ayon_usd"]["allow_addon_start"]:
+            raise SystemError(
+                "The experimental AyonUsd addon is currently activated, but you haven't yet acknowledged the user agreement indicating your understanding that this feature is experimental. Please go to the Studio settings and check the agreement checkbox."
+            )
         self.enabled = True
         self._download_window = None
 
@@ -127,3 +133,18 @@ def tray_menu(self, tray_menu):
     def get_launch_hook_paths(self):
         """Get paths to launch hooks."""
         return [os.path.join(config.USD_ADDON_DIR, "hooks")]
+
+    def get_plugin_paths(self):
+        """Deadline plugin paths."""
+        # Note: We are not returning `publish` key because we have overridden
+        # `get_publish_plugin_paths` to return paths host-specific. However,
+        # `get_plugin_paths` still needs to be implemented because it's
+        # abstract on the parent class
+        return {}
+
+    def get_publish_plugin_paths(self, host_name=None):
+        publish_dir = os.path.join(USD_ADDON_ROOT, "plugins", "publish")
+        paths = [os.path.join(publish_dir, "global")]
+        if host_name:
+            paths.append(os.path.join(publish_dir, host_name))
+        return paths

client/ayon_usd/plugins/publish/houdini/generate_usd_pinning_file.py

@@ -0,0 +1,55 @@
+"""
+Empty Pyblish plugin that used for inspection.
+
+Note: 
+    PLugin's order is an int constant.
+    Current Orders:
+        pyblish.api.CollectorOrder == 0
+        pyblish.api.ValidatorOrder == 1
+        pyblish.api.ExtractorOrder == 2
+        pyblish.api.IntegratorOrder == 3
+
+
+    Sometimes, you can add some number to the order
+      to adjust its order.
+    You may want to adjust the order to make it run
+      after a particular plugin.
+"""
+
+import os
+import pyblish.api
+import ayon_api
+from ayon_core.pipeline.publish import KnownPublishError
+from ayon_usd.standalone.usd.pinning import pinning_file_helper
+
+
+root_info = ayon_api.get_project_roots_for_site(os.environ.get("AYON_PROJECT_NAME"))
+
+
+class Dumb(pyblish.api.InstancePlugin):
+    """Dumb"""
+
+    order = pyblish.api.IntegratorOrder + 0.3
+    label = "Dumb"
+    families = ["usdrop"]
+    hosts = ["houdini"]
+
+    enabled = True
+
+    def process(self, instance):
+
+        publish_dir = instance.data["publishDir"]
+        publish_usd_file = instance.data["representations"][0]["published_path"]
+        pinning_file_path = os.path.join(
+            publish_dir, publish_usd_file.split(".")[0] + "_pinning_file.json"
+        )
+        if not os.path.exists(publish_usd_file):
+            self.log.error(f"Usd file missing {publish_usd_file}")
+            raise KnownPublishError(f"Usd File Missing {publish_usd_file}")
+
+        pinning_file_helper.generate_pinning_file(
+            publish_usd_file, root_info, pinning_file_path
+        )
+        self.log.debug(
+            f"Saving Pinning File for Usd Render Locatoin:{pinning_file_path}, for usd file {publish_usd_file}"
+        )