Merge remote-tracking branch 'origin/feature/AY-5722_Implement_versoi…

…n_off_LakeCtlPy_into_ayonUsdPlugin_excample' into develop

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "client/ayon_usd/ayon_bin_client"]
+	path = client/ayon_usd/ayon_bin_client
+	url = https://github.com/ynput/ayon-bin-bridge-client.git

Docs/Ayon_Docs/Admin_Docs.md

@@ -0,0 +1,97 @@
+## Introduction
+
+> **_NOTE_**\
+> this addon is currently in its Alpha stage and you will need to set some
+> LakeFs keys (LakeFs is the data server we use to distribute Bin data) you can
+> get those Keys on our Discord server just ask one of the Ynput staff for them.
+> the settings are the following:
+> `ayon+settings://ayon_usd/LakeFs_Settings/access_key_id` and
+> `ayon+settings://ayon_usd/LakeFs_Settings/secret_access_key`
+
+USD is a modern, open-source, scene description and file format developed by
+Pixar Animation Studios. Its an Extensive and extendable C++Lib that is used in
+3D, 2D and Games Graphics in order to allow for eficient work with Sceene data.
+
+Many might know it from SideFs Houdini Solaris or Nvidia Omniverse but it is by
+now included in most other Vfx software packages.
+
+In AYON we use it in our New **Contribution workflow** as the data backend to
+allow cross Platform and Application workflows. This allows for better
+integrated Teams and a more artist centric Workflow as artists can open the same
+scene in different applications and work with the tools that serve them the
+best.
+
+Goal of this addon is to extend the Contirbution workflow by automaticly
+distributing Usd and Ayon Libs:
+
+- USD-Lib build for supported platforms.
+- USD AR2 [Asset Resolver](https://github.com/ynput/ayon-usd-resolver) plugin
+  for
+  [**some**](https://github.com/ynput/ayon-usd-resolver?tab=readme-ov-file#tested-platforms)
+  supported DCCs.
+- USD Tools (usdcat, usdedit, usdinfo, usdview, usdzip) coming with USD build.
+- Standalone tools for AYON - Extending the capability and usability of the
+  OpenUsdLib for artists and studios.
+
+## Configuration
+
+there is a list of things that you can configure in the server settings to
+achieve the optimal setup for your studio. In most cases you will probably not
+need to touch them tho.
+
+#### LakeFs Config
+
+**LakeFs Settings:** `ayon+settings://ayon_usd/LakeFs_Settings`\
+LakeFs is the backend of our bin distribution system the addon will use the
+specified server to download the resolvers and AyonUsdLibs from LakeFs.
+
+**LakeFs Server Uri:**
+`ayon+settings://ayon_usd/LakeFs_Settings/ayon_usd_lake_fs_server_repo`\
+this is the Uri used to host the LakeFs server. the Ynput server can be found at
+`https://lake.ayon.cloud`
+
+**LakeFs Repository Uri:**
+`ayon+settings://ayon_usd/LakeFs_Settings/ayon_usd_lake_fs_server_repo`\
+this is a LakeFs internal link that also specifies the branch your downloading
+from.\
+this can be great if you want to pin your pipeline to a specific release.
+
+**Asset Resolvers:** `ayon+settings://ayon_usd/LakeFs_Settings/asset_resolvers`\
+allows you to associate a specific Application name with a specific resolver.\
+we always setup all the resolvers we compile but if you have special App_Names
+in your Applications then you might want to add an App Alias.\
+e.g if you have hou19.5.xxx setup as an variant for Houdini you can then set it
+as an alias for the Hou19.5 entry because they share the same resolver.
+
+#### Usd Resolver Config
+
+`ayon+settings://ayon_usd/Ayon_UsdResolver_Settings`
+
+**Log Lvl** `ayon+settings://ayon_usd/Ayon_UsdResolver_Settings/ayon_log_lvl`
+control the log lvl of the AyonUsdResolver. It is advised to have this at Warn
+or Critical as Logging will impact the performance.
+
+**File Logger Enabled**
+`ayon+settings://ayon_usd/Ayon_UsdResolver_Settings/ayon_file_logger_enabled`
+AyonUsdResolver includes a file logger if needed.
+
+**Logging Keys**
+`ayon+settings://ayon_usd/Ayon_UsdResolver_Settings/ayon_logger_logging_keys`
+AyonUsdResolver Logger has a few predefined logging keys that can be enabled for
+Debugging. it is advised to only do this with Developer bundles as it can expose
+AYON Server data. it will also generate quite a big output.
+
+**File Logger Path**
+`ayon+settings://ayon_usd/Ayon_UsdResolver_Settings/file_logger_file_path` The
+Ayon File Logger needs an output path this needs to be a relative or absolute
+path to a folder.
+
+#### UsdLib Config:
+
+`ayon+settings://ayon_usd/Usd_Settings`
+
+**Tf_Debug** `ayon+settings://ayon_usd/Usd_Settings/usd_tf_debug`\
+this allows you to set the UsdTfDebug env variable to get extra debug info from
+the UsdLib.\
+[Usd Survival Guide (Luca Sheller)](https://lucascheller.github.io/VFX-UsdSurvivalGuide/core/profiling/debug.html)\
+[OpenUsd Debug Wiki](https://openusd.org/release/api/group__group__tf___debugging_output.html)

Docs/Ayon_Docs/Dev_Docs.md

@@ -0,0 +1,26 @@
+# Developer Docs
+
+Most important Locations.
+
+1. config
+   - provides general addon config and a list of variables and functions to
+     access settings across the addon.
+   - also allows to get lakeFs related classes and functions in there global
+     state
+2. hooks
+   - Ayon + Pyblish related addons and hooks.
+3. standalone
+   - AyonUsd standalone tools. They should be DCC agnostic.
+4. utils
+   - utility functions to make interaction with the addon simpler.
+
+## Standalone
+
+### 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.
+
+The rest of this can be found in the pinning support Branch

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -1,41 +1,30 @@
 # AYON USD Addon
 
-This is AYON Addon for support of [USD](https://github.com/PixarAnimationStudios/OpenUSD).
+This AYON Addon acts as an extension for the **AYON Contribution workflow**
+utilizing the
+[Open-USD Framework](https://github.com/PixarAnimationStudios/OpenUSD) to allow
+for a more automated workflow across Applications, Systems and Teams.
 
-It helps to distribute USD binaries and related tools to artist workstations and
-to configure its environment.
+You can find Admin and Developer docs under Docs/Ayon_Docs/
 
-## Introduction
-
-USD is a modern, open-source, scene description and file format developed by
-Pixar Animation Studios. It is used for interchanging 3D graphics data between
-applications and for rendering.
-
-Goal of this addon is to help distribute USD binaries:
+## Getting Started
 
-- USD build for supported platforms.
-- USD AR2 plugin for __some__ supported DCCs.
-- USD Tools (usdcat, usdedit, usdinfo, usdview, usdzip) coming with USD build.
-- Standalone tools for AYON - USD interoperation.
+### Clone the Repo
 
-## Getting Started
+> **_IMOPRTANT_**\
+> This repository uses Git Submodules. Make sure to use the correct `git clone`\
+> commands accordingly.\
+> `git clone --recurse-submodules https://github.com/ynput/ayon-usd.git`\
+> `git submodule update --init --recursive`
 
 ### Installation
 
 1. Clone the repository to your local machine.
-2. Run `.\tools\manage.ps1 create-env` on Windows or `./tools/manage.sh create-env` on Linux.
-3. Run `.\tools\manage.ps1 build` on Windows or `./tools/manage.sh build` on Linux.
-4. In AYON, go to `Studio Settings` -> `Bundles` -> `Install Addons...` and select the `./package/ayon_usd-x.x.x.zip` file.
+2. Run `.\tools\manage.ps1 create-env` on Windows or
+   `./tools/manage.sh create-env` on Linux.
+3. Run `.\tools\manage.ps1 build` on Windows or `./tools/manage.sh build` on
+   Linux.
+4. In AYON, go to `Studio Settings` -> `Bundles` -> `Install Addons...` and
+   select the `./package/ayon_usd-x.x.x.zip` file.
 5. Upload the Addon and let the server restart after installation is done.
 6. Use new addon in your bundles.
-
-### Configuration
-
-In addon settings, you can configure mapping between USD Resolver plugin and you DCCs.
-`App Name` is the name of the DCC application, like `maya/2025` corresponding
-to the Application addon settings. Then there is a platform settings, where you
-can specify the platform for which the USD Asset Resolver plugin is used.
-Lastly, there is a URL to the USD Asset Resolver plugin zip matching the platform and
-the DCC application.
-
-`ayon+settings://ayon_usd/asset_resolvers` is the key for the settings.