diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 2339ec878fd..d7e49de5cbf 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -35,6 +35,34 @@ body:
label: Version
description: What version are you running? Look to OpenPype Tray
options:
+ - 3.16.5-nightly.2
+ - 3.16.5-nightly.1
+ - 3.16.4
+ - 3.16.4-nightly.3
+ - 3.16.4-nightly.2
+ - 3.16.4-nightly.1
+ - 3.16.3
+ - 3.16.3-nightly.5
+ - 3.16.3-nightly.4
+ - 3.16.3-nightly.3
+ - 3.16.3-nightly.2
+ - 3.16.3-nightly.1
+ - 3.16.2
+ - 3.16.2-nightly.2
+ - 3.16.2-nightly.1
+ - 3.16.1
+ - 3.16.0
+ - 3.16.0-nightly.2
+ - 3.16.0-nightly.1
+ - 3.15.12
+ - 3.15.12-nightly.4
+ - 3.15.12-nightly.3
+ - 3.15.12-nightly.2
+ - 3.15.12-nightly.1
+ - 3.15.11
+ - 3.15.11-nightly.5
+ - 3.15.11-nightly.4
+ - 3.15.11-nightly.3
- 3.15.11-nightly.2
- 3.15.11-nightly.1
- 3.15.10
@@ -107,34 +135,6 @@ body:
- 3.14.8-nightly.4
- 3.14.8-nightly.3
- 3.14.8-nightly.2
- - 3.14.8-nightly.1
- - 3.14.7
- - 3.14.7-nightly.8
- - 3.14.7-nightly.7
- - 3.14.7-nightly.6
- - 3.14.7-nightly.5
- - 3.14.7-nightly.4
- - 3.14.7-nightly.3
- - 3.14.7-nightly.2
- - 3.14.7-nightly.1
- - 3.14.6
- - 3.14.6-nightly.3
- - 3.14.6-nightly.2
- - 3.14.6-nightly.1
- - 3.14.5
- - 3.14.5-nightly.3
- - 3.14.5-nightly.2
- - 3.14.5-nightly.1
- - 3.14.4
- - 3.14.4-nightly.4
- - 3.14.4-nightly.3
- - 3.14.4-nightly.2
- - 3.14.4-nightly.1
- - 3.14.3
- - 3.14.3-nightly.7
- - 3.14.3-nightly.6
- - 3.14.3-nightly.5
- - 3.14.3-nightly.4
validations:
required: true
- type: dropdown
diff --git a/.github/workflows/miletone_release_trigger.yml b/.github/workflows/miletone_release_trigger.yml
index 4a031be7f90..d755f7eb9fb 100644
--- a/.github/workflows/miletone_release_trigger.yml
+++ b/.github/workflows/miletone_release_trigger.yml
@@ -5,12 +5,6 @@ on:
inputs:
milestone:
required: true
- release-type:
- type: choice
- description: What release should be created
- options:
- - release
- - pre-release
milestone:
types: closed
diff --git a/.gitignore b/.gitignore
index 50f52f65a31..622d55fb883 100644
--- a/.gitignore
+++ b/.gitignore
@@ -37,6 +37,7 @@ Temporary Items
###########
/build
/dist/
+/server_addon/packages/*
/vendor/bin/*
/vendor/python/*
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 882620f26c9..f1948b1a3f7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,3348 @@
# Changelog
+## [3.16.4](https://github.com/ynput/OpenPype/tree/3.16.4)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.16.3...3.16.4)
+
+### **🆕 New features**
+
+
+
+Feature: Download last published workfile specify version #4998
+
+Setting `workfile_version` key to hook's `self.launch_context.data` allow you to specify the workfile version you want sync service to download if none is matched locally. This is helpful if the last version hasn't been correctly published/synchronized, and you want to recover the previous one (or some you'd like).Version could be set in two ways:
+- OP's absolute version, matching the `version` index in DB.
+- Relative version in reverse order from the last one: `-2`, `-3`...I don't know where I should write documentation about that.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Maya: allow not creation of group for Import loaders #5427
+
+This PR enhances previous one. All ReferenceLoaders could not wrap imported products into explicit group.Also `Import` Loaders have same options. Control for this is separate in Settings, eg. Reference might wrap loaded items in group, `Import` might not.
+
+
+___
+
+
+
+
+
+3dsMax: Settings for Ayon #5388
+
+Max Addon Setting for Ayon
+
+
+___
+
+
+
+
+
+General: Navigation to Folder from Launcher #5404
+
+Adds an action in launcher to open the directory of the asset.
+
+
+___
+
+
+
+
+
+Chore: Default variant in create plugin #5429
+
+Attribute `default_variant` on create plugins always returns string and if default variant is not filled other ways how to get one are implemented.
+
+
+___
+
+
+
+
+
+Publisher: Thumbnail widget enhancements #5439
+
+Thumbnails widget in Publisher has new 3 options to choose from: Paste (from clipboard), Take screenshot and Browse. Clear button and new options are not visible by default, user must expand options button to show them.
+
+
+___
+
+
+
+
+
+AYON: Update ayon api to '0.3.5' #5460
+
+Updated ayon-python-api to 0.3.5.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+AYON: Apply unknown ayon settings first #5435
+
+Settings of custom addons are available in converted settings.
+
+
+___
+
+
+
+
+
+Maya: Fix wrong subset name of render family in deadline #5442
+
+New Publisher is creating different subset names than previously which resulted in duplication of `render` string in final subset name of `render` family published on Deadline.This PR solves that, it also fixes issues with legacy instances from old publisher, it matches the subset name as was before.This solves same issue in Max implementation.
+
+
+___
+
+
+
+
+
+Maya: Fix setting of version to workfile instance #5452
+
+If there are multiple instances of renderlayer published, previous logic resulted in unpredictable rewrite of instance family to 'workfile' if `Sync render version with workfile` was on.
+
+
+___
+
+
+
+
+
+Maya: Context plugin shouldn't be tied to family #5464
+
+`Maya Current File` collector was tied to `workfile` unnecessary. It should run even if `workile` instance is not being published.
+
+
+___
+
+
+
+
+
+Unreal: Fix loading hero version for static and skeletal meshes #5393
+
+Fixed a problem with loading hero versions for static ans skeletal meshes.
+
+
+___
+
+
+
+
+
+TVPaint: Fix 'repeat' behavior #5412
+
+Calculation of frames for repeat behavior is working correctly.
+
+
+___
+
+
+
+
+
+AYON: Thumbnails cache and api prep #5437
+
+Moved thumbnails cache from ayon python api to OpenPype and prepare AYON thumbnail resolver for new api functions. Current implementation should work with old and new ayon-python-api.
+
+
+___
+
+
+
+
+
+Nuke: Name of the Read Node should be updated correctly when switching versions or assets. #5444
+
+Bug fixing of the read node's name not being updated correctly when setting version or switching asset.
+
+
+___
+
+
+
+
+
+Farm publishing: asymmetric handles fixed #5446
+
+Handles are now set correctly on farm published product version if asymmetric were set to shot attributes.
+
+
+___
+
+
+
+
+
+Scene Inventory: Provider icons fix #5450
+
+Fix how provider icons are accessed in scene inventory.
+
+
+___
+
+
+
+
+
+Fix typo on Deadline OP plugin name #5453
+
+Surprised that no one has hit this bug yet... but it seems like there was a typo on the name of the OP Deadline plugin when submitting jobs to it.
+
+
+___
+
+
+
+
+
+AYON: Fix version attributes update #5472
+
+Fixed updates of attribs in AYON mode.
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+Added missing defaults for import_loader #5447
+
+
+___
+
+
+
+
+
+Bug: Local settings don't open on 3.14.7 #5220
+
+### Before posting a new ticket, have you looked through the documentation to find an answer?
+
+Yes I have
+
+### Have you looked through the existing tickets to find any related issues ?
+
+Not yet
+
+### Author of the bug
+
+@FadyFS
+
+### Version
+
+3.15.11-nightly.3
+
+### What platform you are running OpenPype on?
+
+Linux / Centos
+
+### Current Behavior:
+
+the previous behavior (bug) :
+
+
+
+### Expected Behavior:
+
+
+
+
+### What type of bug is it ?
+
+Happened only once in a particular configuration
+
+### Which project / workfile / asset / ...
+
+open settings with 3.14.7
+
+### Steps To Reproduce:
+
+1. Run openpype on the 3.15.11-nightly.3 version
+2. Open settings in 3.14.7 version
+
+### Relevant log output:
+
+_No response_
+
+### Additional context:
+
+_No response_
+
+___
+
+
+
+
+
+Tests: Add automated targets for tests #5443
+
+Without it plugins with 'automated' targets won't be triggered (eg `CloseAE` etc.)
+
+
+___
+
+
+
+
+
+
+## [3.16.3](https://github.com/ynput/OpenPype/tree/3.16.3)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.16.2...3.16.3)
+
+### **🆕 New features**
+
+
+
+AYON: 3rd party addon usage #5300
+
+Prepare OpenPype code to be able use `ayon-third-party` addon which supply ffmpeg and OpenImageIO executables. Because they both can support to define custom arguments (more than one) a new functions were needed to supply.New functions are `get_ffmpeg_tool_args` and `get_oiio_tool_args`. They work similar to previous but instead of string are returning list of strings. All places using previous functions `get_ffmpeg_tool_path` and `get_oiio_tool_path` are now using new ones. They should be backwards compatible and even with addon if returns single argument.
+
+
+___
+
+
+
+
+
+AYON: Addon settings in OpenPype #5347
+
+Moved settings addons to OpenPype server addon. Modified create package to create zip files for server for each settings addon and for openpype addon.
+
+
+___
+
+
+
+
+
+AYON: Add folder to template data #5417
+
+Added `folder` to template data, so `{folder[name]}` can be used in templates.
+
+
+___
+
+
+
+
+
+Option to start versioning from 0 #5262
+
+This PR adds a settings option to start all versioning from 0.This PR will replace #4455.
+
+
+___
+
+
+
+
+
+Ayon: deadline implementation #5321
+
+Quick implementation of deadline in Ayon. New Ayon plugin added for Deadline repository
+
+
+___
+
+
+
+
+
+AYON: Remove AYON launch logic from OpenPype #5348
+
+Removed AYON launch logic from OpenPype. The logic is outdated at this moment and is replaced by `ayon-launcher`.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Bug: Error on multiple instance rig with maya #5310
+
+I change endswith method by startswith method because the set are automacaly name out_SET, out_SET1, out_SET2 ...
+
+
+___
+
+
+
+
+
+Applications: Use prelaunch hooks to extract environments #5387
+
+Environment variable preparation is based on prelaunch hooks. This should allow to pass OCIO environment variables to farm jobs.
+
+
+___
+
+
+
+
+
+Applications: Launch hooks cleanup #5395
+
+Use `set` instead of `list` for filtering attributes in launch hooks. Celaction hooks dir does not contain `__init__.py`. Celaction prelaunch hook is reusing `CELACTION_ROOT_DIR`. Launch hooks are using full import from `openpype.lib.applications`.
+
+
+___
+
+
+
+
+
+Applications: Environment variables order #5245
+
+Changed order of set environment variables. First are set context environment variables and then project environment overrides. Also asset and task environemnt variables are optional.
+
+
+___
+
+
+
+
+
+Autosave preferences can be read after Nuke opens the script #5295
+
+Looks like I need to open the script in Nuke to be able to correctly load the autosave preferences.This PR reads the Nuke script in context, and offers owerwriting the current script with autosaved one if autosave exists.
+
+
+___
+
+
+
+
+
+Resolve: Update with compatible resolve version and latest docs #5317
+
+Missing information about compatible Resolve version and latest docs from https://github.com/ynput/OpenPype/tree/develop/openpype/hosts/resolve
+
+
+___
+
+
+
+
+
+Chore: Remove deprecated functions #5323
+
+Removed functions/classes that are deprecated and marked to be removed.
+
+
+___
+
+
+
+
+
+Nuke Render and Prerender nodes Process Order - OP-3555 #5332
+
+This PR exposes control over the order of processing of the instances, by sorting the instances created. The sorting happens on the `render_order` and subset name. If the knob `render_order` is found on the instance, we'll sort by that first before sorting by subset name.`render_order` instances are processed before nodes without `render_order`. This could be extended in the future by querying other knobs but I dont know of a usecase for this.Hardcoded the creator `order` attribute of the `prerender` class to be before the `render`. Could be exposed to the user/studio but dont know of a use case for this.
+
+
+___
+
+
+
+
+
+Unreal: Python Environment Improvements #5344
+
+Automatically set `UE_PYTHONPATH` as `PYTHONPATH` when launching Unreal.
+
+
+___
+
+
+
+
+
+Unreal: Custom location for Unreal Ayon Plugin #5346
+
+Added a new environment variable `AYON_BUILT_UNREAL_PLUGIN` to set an already existing and built Ayon Plugin for Unreal.
+
+
+___
+
+
+
+
+
+Unreal: Better handling of Exceptions in UE Worker threads #5349
+
+Implemented a new `UEWorker` base class to handle exception during the execution of UE Workers.
+
+
+___
+
+
+
+
+
+Houdini: Add farm toggle on creation menu #5350
+
+Deadline Farm publishing and Rendering for Houdini was possible with this PR #4825 farm publishing is enabled by default some ROP nodes which may surprise new users (like me).I think adding a toggle (on by default) on creation UI is better so that users will be aware that there's a farm option for this publish instance.ROPs Modified :
+- [x] Mantra ROP
+- [x] Karma ROP
+- [x] Arnold ROP
+- [x] Redshift ROP
+- [x] Vray ROP
+
+
+___
+
+
+
+
+
+Ftrack: Sync to avalon settings #5353
+
+Added roles settings for sync to avalon action.
+
+
+___
+
+
+
+
+
+Chore: Schemas inside OpenPype #5354
+
+Moved/copied schemas from repository root inside openpype/pipeline.
+
+
+___
+
+
+
+
+
+AYON: Addons creation enhancements #5356
+
+Enhanced AYON addons creation. Fix issue with `Pattern` typehint. Zip filenames contain version. OpenPype package is skipping modules that are already separated in AYON. Updated settings of addons.
+
+
+___
+
+
+
+
+
+AYON: Update staging icons #5372
+
+Updated staging icons for staging mode.
+
+
+___
+
+
+
+
+
+Enhancement: Houdini Update pointcache labels #5373
+
+To me it's logical to find pointcaches types listed one after another, but they were named differentlySo, I made this PR to update their labels
+
+
+___
+
+
+
+
+
+nuke: split write node product instance features #5389
+
+Improving Write node product instances by allowing precise activation of specific features.
+
+
+___
+
+
+
+
+
+Max: Use the empty modifiers in container to store AYON Parameter #5396
+
+Instead of adding AYON/OP Parameter along with other attributes inside the container, empty modifiers would be created to store AYON/OP custom attributes
+
+
+___
+
+
+
+
+
+AfterEffects: Removed unused imports #5397
+
+Removed unused import from extract local render plugin file.
+
+
+___
+
+
+
+
+
+Nuke: adding BBox knob type to settings #5405
+
+Nuke knob types in settings having new `Box` type for reposition nodes like Crop or Reformat.
+
+
+___
+
+
+
+
+
+SyncServer: Existence of module is optional #5413
+
+Existence of SyncServer module is optional and not required. Added `sync_server` module back to ignored modules when openpype addon is created for AYON. Command `syncserver` is marked as deprecated and redirected to sync server cli.
+
+
+___
+
+
+
+
+
+Webpublisher: Self contain test publish logic #5414
+
+Moved test logic of publishing to webpublisher. Simplified `remote_publish` to remove webpublisher specific logic.
+
+
+___
+
+
+
+
+
+Webpublisher: Cleanup targets #5418
+
+Removed `remote` target from webpublisher and replaced it with 2 targets `webpublisher` and `automated`.
+
+
+___
+
+
+
+
+
+nuke: update server addon settings with box #5419
+
+updtaing nuke ayon server settings for Box option in knob types.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+Maya: fix validate frame range on review attached to other instances #5296
+
+Fixes situation where frame range validator can't be turned off on models if they are attached to reviewable camera in Maya.
+
+
+___
+
+
+
+
+
+Maya: Apply project settings to creators #5303
+
+Project settings were not applied to the creators.
+
+
+___
+
+
+
+
+
+Maya: Validate Model Content #5336
+
+`assemblies` in `cmds.ls` does not seem to work;
+```python
+
+from maya import cmds
+
+
+content_instance = ['|group2|pSphere1_GEO', '|group2|pSphere1_GEO|pSphere1_GEOShape', '|group1|pSphere1_GEO', '|group1|pSphere1_GEO|pSphere1_GEOShape']
+assemblies = cmds.ls(content_instance, assemblies=True, long=True)
+print(assemblies)
+```
+
+Fixing with string splitting instead.
+
+
+___
+
+
+
+
+
+Bugfix: Maya update defaults variable #5368
+
+So, something was forgotten while moving out from `LegacyCreator` to `NewCreator``LegacyCreator` used `defaults` to list suggested subset names which was changed into `default_variants` in the the `NewCreator`and setting `defaults` to any values has no effect!This update affects:
+- [x] Model
+- [x] Set Dress
+
+
+___
+
+
+
+
+
+Chore: Python 2 support fix #5375
+
+Fix Python 2 support by adding `click` into python 2 dependencies and removing f-string from maya.
+
+
+___
+
+
+
+
+
+Maya: do not create top level group on reference #5402
+
+This PR allows to not wrapping loaded referenced assets in top level group either explicitly for artist or by configuration in Settings.Artists can control group creation in ReferenceLoader options.Default no group creation could be set by emptying `Group Name` in `project_settings/maya/load/reference_loader`
+
+
+___
+
+
+
+
+
+Settings: Houdini & Maya create plugin settings #5436
+
+Fixes related to Maya and Houdini settings. Renamed `defaults` to `default_variants` in plugin settings to match attribute name on create plugin in both OpenPype and AYON settings. Fixed Houdini AYON settings where were missing settings for defautlt varaints and fixed Maya AYON settings where default factory had wrong assignment.
+
+
+___
+
+
+
+
+
+Maya: Hide CreateAnimation #5297
+
+When converting `animation` family or loading a `rig` family, need to include the `animation` creator but hide it in creator context.
+
+
+___
+
+
+
+
+
+Nuke Anamorphic slate - Read pixel aspect from input #5304
+
+When asset pixel aspect differs from rendered pixel aspect, Nuke slate pixel aspect is not longer taken from asset, but is readed via ffprobe.
+
+
+___
+
+
+
+
+
+Nuke - Allow ExtractReviewDataMov with no timecode knob #5305
+
+ExtractReviewDataMov allows to specify file type. Trying to write some other extension than mov fails on generate_mov assuming that mov64_write_timecode knob exists.
+
+
+___
+
+
+
+
+
+Nuke: removing settings schema with defaults for OpenPype #5306
+
+continuation of https://github.com/ynput/OpenPype/pull/5275
+
+
+___
+
+
+
+
+
+Bugfix: Dependency without 'inputLinks' not downloaded #5337
+
+Remove condition that avoids downloading dependency without `inputLinks`.
+
+
+___
+
+
+
+
+
+Bugfix: Houdini Creator use selection even if it was toggled off #5359
+
+When creating many product types (families) one after another without refreshing the creator window manually if you toggled `Use selection` once, all the later product types will use selection even if it was toggled offHere's Before it will keep use selection even if it was toggled off, unless you refresh window manuallyhttps://github.com/ynput/OpenPype/assets/20871534/8b890122-5b53-4c6b-897d-6a2f3aa3388aHere's After it works as expectedhttps://github.com/ynput/OpenPype/assets/20871534/6b1db990-de1b-428e-8828-04ab59a44e28
+
+
+___
+
+
+
+
+
+Houdini: Correct camera selection for karma renderer when using selected node #5360
+
+When user creates the karma rop with selected camera by use selection, it will give the error message of "no render camera found in selection".This PR is to fix the bug of creating karma rop when using selected camera node in Houdini
+
+
+___
+
+
+
+
+
+AYON: Environment variables and functions #5361
+
+Prepare code for ayon-launcher compatibility. Fix ayon launcher subprocess calls, added more checks for `AYON_SERVER_ENABLED`, use ayon launcher suitable environment variables in AYON mode and changed outputs of some functions. Replaced usages of `OPENPYPE_REPOS_ROOT` environment variable with `PACKAGE_DIR` variable -> correct paths are used.
+
+
+___
+
+
+
+
+
+Nuke: farm rendering of prerender ignore roots in nuke #5366
+
+`prerender` family was using wrong subset, same as `render` which should be different.
+
+
+___
+
+
+
+
+
+Bugfix: Houdini update defaults variable #5367
+
+So, something was forgotten while moving out from `LegacyCreator` to `NewCreator``LegacyCreator` used `defaults` to list suggested subset names which was changed into `default_variants` in the the `NewCreator`and setting `defaults` to any values has no effect!This update affects:
+- [x] Arnold ASS
+- [x] Arnold ROP
+- [x] Karma ROP
+- [x] Mantra ROP
+- [x] Redshift ROP
+- [x] VRay ROP
+
+
+___
+
+
+
+
+
+Publisher: Fix create/publish animation #5369
+
+Use geometry movement instead of changing min/max width.
+
+
+___
+
+
+
+
+
+Unreal: Move unreal splash screen to unreal #5370
+
+Moved splash screen code to unreal integration and removed import from Igniter.
+
+
+___
+
+
+
+
+
+Nuke: returned not cleaning of renders folder on the farm #5374
+
+Previous PR enabled explicit cleanup of `renders` folder after farm publishing. This is not matching customer's workflows. Customer wants to have access to files in `renders` folder and potentially redo some frames for long frame sequences.This PR extends logic of marking rendered files for deletion only if instance doesn't have `stagingDir_persistent`.For backwards compatibility all Nuke instances have `stagingDir_persistent` set to True, eg. `renders` folder won't be cleaned after farm publish.
+
+
+___
+
+
+
+
+
+Nuke: loading sequences is working #5376
+
+Loading image sequences was broken after the latest release, version 3.16. However, I am pleased to inform you that it is now functioning as expected.
+
+
+___
+
+
+
+
+
+AYON: Fix settings conversion for ayon addons #5377
+
+AYON addon settings are available in system settings and does not have available the same values in `"modules"` subkey.
+
+
+___
+
+
+
+
+
+Nuke: OCIO env var workflow #5379
+
+The OCIO environment variable needs to be consistently handled across all platforms. Nuke resolves the custom OCIO config path differently depending on the platform, so we included the ocio config path in the workfile with a partial replacement using an environment variable. Additionally, for Windows sessions, we replaced backward slashes with a TCL expression.
+
+
+___
+
+
+
+
+
+Unreal: Fix Unreal build script #5381
+
+Define 'AYON_UNREAL_ROOT' environment variable in unreal addon.
+
+
+___
+
+
+
+
+
+3dsMax: Use relative path to MAX_HOST_DIR #5382
+
+Use `MAX_HOST_DIR` to calculate startup script path instead of use relative path to `OPENPYPE_ROOT` environment variable.
+
+
+___
+
+
+
+
+
+Bugfix: Houdini abc validator error message #5386
+
+When ABC path validator fails, it prints node objects not node paths or namesThis bug happened because of updating `get_invalid` method to return nodes instead of node pathsBeforeAfter
+
+
+___
+
+
+
+
+
+Nuke: node name influence product (subset) name #5392
+
+Nuke now allows users to duplicate publishing instances, making the workflow easier. By duplicating a node and changing its name, users can set the product (subset) name in the publishing context.Users now have the ability to change the variant name in Publisher, which will automatically rename the associated instance node.
+
+
+___
+
+
+
+
+
+Houdini: delete redundant bgeo sop validator #5394
+
+I found out that this `Validate BGEO SOP Path` validator is redundant, it catches two cases that are already implemented in "Validate Output Node". "Validate Output Node" works with `bgeo` as well as `abc` because `"pointcache"` is listed in its families
+
+
+___
+
+
+
+
+
+Nuke: workfile is not reopening after change of context #5399
+
+Nuke no longer reopens the latest workfile when the context is changed to a different task using the Workfile tool. The issue also affected the Script Clean (from Nuke File menu) and Close feature, but it has now been fixed.
+
+
+___
+
+
+
+
+
+Bugfix: houdini hard coded project settings #5400
+
+I made this PR to solve the issue with hard-coded settings in houdini
+
+
+___
+
+
+
+
+
+AYON: 3dsMax settings #5401
+
+Keep `adsk_3dsmax` group in applications settings.
+
+
+___
+
+
+
+
+
+Bugfix: update defaults to default_variants in maya and houdini OP DCC settings #5407
+
+On moving out to new creator in Maya and Houdini updating settings was missed.
+
+
+___
+
+
+
+
+
+Applications: Attributes creation #5408
+
+Applications addon does not cause infinite server restart loop.
+
+
+___
+
+
+
+
+
+Max: fix the bug of handling Object deletion in OP Parameter #5410
+
+If the object is added to the OP parameter and user delete it in the scene thereafter, it will error out the container with OP attributes. This PR resolves the bug.This PR also fixes the bug of not adding the attribute into OP parameter correctly when the user enables "use selections" to link the object into the OP parameter.
+
+
+___
+
+
+
+
+
+Colorspace: including environments from launcher process #5411
+
+Fixed bug in GitHub PR where the OCIO config template was not properly formatting environment variables from System Settings `general/environment`.
+
+
+___
+
+
+
+
+
+Nuke: workfile template fixes #5428
+
+Some bunch of small bugs needed to be fixed
+
+
+___
+
+
+
+
+
+Houdini, Max: Fix missed function interface change #5430
+
+This PR https://github.com/ynput/OpenPype/pull/5321/files from @kalisp missed updating the `add_render_job_env_var` in Houdini and Max as they are passing an extra arg:
+```
+TypeError: add_render_job_env_var() takes 1 positional argument but 2 were given
+```
+
+
+___
+
+
+
+
+
+Scene Inventory: Fix issue with 'sync_server' #5431
+
+Fix accesss to `sync_server` attribute in scene inventory.
+
+
+___
+
+
+
+
+
+Unpack project: Fix import issue #5433
+
+Added `load_json_file`, `replace_project_documents` and `store_project_documents` to mongo init.
+
+
+___
+
+
+
+
+
+Chore: Versions post fixes #5441
+
+Fixed issues caused by my fault. Filled right version value to anatomy data.
+
+
+___
+
+
+
+### **📃 Testing**
+
+
+
+Tests: Copy file_handler as it will be removed by purging ayon code #5357
+
+Ayon code will get purged in the future from this repo/addon, therefore all `ayon_common` will be gone. `file_handler` gets internalized to tests as it is not used anywhere else.
+
+
+___
+
+
+
+
+
+
+## [3.16.2](https://github.com/ynput/OpenPype/tree/3.16.2)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.16.1...3.16.2)
+
+### **🆕 New features**
+
+
+
+Fusion - Set selected tool to active #5327
+
+When you run the action to select a node, this PR makes the node-flow show the selected node + you'll see the nodes controls in the inspector.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Maya: All base create plugins #5326
+
+Prepared base classes for each creator type in Maya. Extended `MayaCreatorBase` to have default implementations of common logic with instances which is used in each type of plugin.
+
+
+___
+
+
+
+
+
+Windows: Support long paths on zip updates. #5265
+
+Support long paths for version extract on Windows.Use case is when having long paths in for example an addon. You can install to the C drive but because the zip files are extracted in the local users folder, it'll add additional sub directories to the paths and quickly get too long paths for Windows to handle the zip updates.
+
+
+___
+
+
+
+
+
+Blender: Added setting to set resolution and start/end frames at startup #5338
+
+This PR adds `set_resolution_startup`and `set_frames_startup` settings. They automatically set respectively the resolution and start/end frames and FPS in Blender when opening a file or creating a new one.
+
+
+___
+
+
+
+
+
+Blender: Support for ExtractBurnin #5339
+
+This PR adds support for ExtractBurnin for Blender, when publishing a Review.
+
+
+___
+
+
+
+
+
+Blender: Extract Camera as Alembic #5343
+
+Added support to extract Alembic Cameras in Blender.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+Maya: Validate Instance In Context #5335
+
+Missing new publisher error so the repair action shows up.
+
+
+___
+
+
+
+
+
+Settings: Fix default settings #5311
+
+Fixed defautl settings for shotgrid. Renamed `FarmRootEnumEntity` to `DynamicEnumEntity` and removed doubled ABC metaclass definition (all settings entities have abstract metaclass).
+
+
+___
+
+
+
+
+
+Deadline: missing context argument #5312
+
+Updated function arguments
+
+
+___
+
+
+
+
+
+Qt UI: Multiselection combobox PySide6 compatibility #5314
+
+- The check states are replaced with the values for PySide6
+- `QtCore.Qt.ItemIsUserTristate` is used instead of `QtCore.Qt.ItemIsTristate` to avoid crashes on PySide6
+
+
+___
+
+
+
+
+
+Docker: handle openssl 1.1.1 for centos 7 docker build #5319
+
+Move to python 3.9 has added need to use openssl 1.1.x - but it is not by default available on centos 7 image. This is fixing it.
+
+
+___
+
+
+
+
+
+houdini: fix typo in redshift proxy #5320
+
+I believe there's a typo in `create_redshift_proxy.py` ( extra ` ) in filename, and I made this PR to suggest a fix
+
+
+___
+
+
+
+
+
+Houdini: fix wrong creator identifier in pointCache workflow #5324
+
+FIxing a bug in publishing alembics, were invalid creator identifier caused missing family association.
+
+
+___
+
+
+
+
+
+Fix colorspace compatibility check #5334
+
+for some reason a user may have `PyOpenColorIO` installed to his machine, _in my case it came with renderman._it can trick the compatibility check as `import PyOpenColorIO` won't raise an error however it may be an old version _like my case_Beforecompatibility check was true and It used wrapper directly After Fix It will use wrapper via subprocess instead
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+Remove forgotten dev logging #5315
+
+
+___
+
+
+
+
+
+
+## [3.16.1](https://github.com/ynput/OpenPype/tree/3.16.1)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.16.0...3.16.1)
+
+### **🆕 New features**
+
+
+
+Royal Render: Maya and Nuke support #5191
+
+Basic working implementation of Royal Render support in Maya.It expects New publisher implemented in Maya.
+
+
+___
+
+
+
+
+
+Blender: Blend File Family #4321
+
+Implementation of the Blend File family analogue to the Maya Scene one.
+
+
+___
+
+
+
+
+
+Houdini: simple bgeo publishing #4588
+
+Support for simple publishing of bgeo files.
+
+This is adding basic support for bgeo publishing in Houdini. It will allow publishing bgeo in all supported formats (selectable in the creator options). If selected node has `output` on sop level, it will be used automatically as path in file node.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+General: delivery action add renamed frame number in Loader #5024
+
+Frame Offset options for delivery in Openpype loader
+
+
+___
+
+
+
+
+
+Enhancement/houdini add path action for abc validator #5237
+
+Add a default path attribute Action.it's a helper action more than a repair action, which used to add a default single value.
+
+
+___
+
+
+
+
+
+Nuke: auto apply all settings after template build #5277
+
+Adding auto run of Apply All Settings after template is builder is finishing its process. This will apply Frame-range, Image size, Colorspace found in context of a task shot.
+
+
+___
+
+
+
+
+
+Harmony:Removed loader settings for Harmony #5289
+
+It shouldn't be configurable, it is internal logic. By adding additional extension it wouldn't start to work magically.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+AYON: Make appdirs case sensitive #5298
+
+Appdirs for AYON are case sensitive for linux and mac so we needed to change them to match ayon launcher. Changed 'ayon' to 'AYON' and 'ynput' to 'Ynput'.
+
+
+___
+
+
+
+
+
+Traypublisher: Fix plugin order #5299
+
+Frame range collector for traypublisher was moved to traypublisher plugins and changed order to make sure `assetEntity` is filled in `instance.data`.
+
+
+___
+
+
+
+
+
+Deadline: removing OPENPYPE_VERSION from some host submitters #5302
+
+Removing deprecated method of adding OPENPYPE_VERSION to job environment. It was leftover and other hosts have already been cleared.
+
+
+___
+
+
+
+
+
+AYON: Fix args for workfile conversion util #5308
+
+Workfile update conversion util function have right expected arguments.
+
+
+___
+
+
+
+### **🔀 Refactored code**
+
+
+
+Maya: Refactor imports to `lib.get_reference_node` since the other function… #5258
+
+Refactor imports to `lib.get_reference_node` since the other function is deprecated.
+
+
+___
+
+
+
+
+
+
+## [3.16.0](https://github.com/ynput/OpenPype/tree/3.16.0)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/...3.16.0)
+
+### **🆕 New features**
+
+
+
+General: Reduce usage of legacy io #4723
+
+Replace usages of `legacy_io` with getter methods or reuse already available information. Create plugins using CreateContext are using context from CreateContext object. Loaders are usign getter function from context tools. Publish plugin are using information instance.data or context.data. In some cases were pieces of code refactored a little e.g. fps getter in maya.
+
+
+___
+
+
+
+
+
+Documentation: API docs reborn - yet again #4419
+
+## Feature
+
+Add functional base for API Documentation using Sphinx and AutoAPI.
+
+After unsuccessful #2512, #834 and #210 this is yet another try. But this time without ambition to solve the whole issue. This is making Shinx script to work and nothing else. Any changes and improvements in API docs should be made in subsequent PRs.
+
+## How to use it
+
+You can run:
+
+```sh
+cd .\docs
+make.bat html
+```
+
+or
+
+```sh
+cd ./docs
+make html
+```
+
+This will go over our code and generate **.rst** files in `/docs/source/autoapi` and from those it will generate full html documentation in `/docs/build/html`.
+
+During the build you'll see tons of red errors that are pointing to our issues:
+
+1) **Wrong imports**
+ Invalid import are usually wrong relative imports (too deep) or circular imports.
+
+2) **Invalid doc-strings**
+ Doc-strings to be processed into documentation needs to follow some syntax - this can be checked by running
+ `pydocstyle` that is already included with OpenPype
+3) **Invalid markdown/rst files**
+ md/rst files can be included inside rst files using `.. include::` directive. But they have to be properly formatted.
+
+
+## Editing rst templates
+
+Everything starts with `/docs/source/index.rst` - this file should be properly edited, Right now it just includes `readme.rst` that in turn include and parse main `README.md`. This is entrypoint to API documentation. All templates generated by AutoAPI are in `/docs/source/autoapi`. They should be eventually commited to repository and edited too.
+
+## Steps for enhancing API documentation
+
+1) Run `/docs/make.bat html`
+2) Read the red errors/warnings - fix it in the code
+3) Run `/docs/make.bat html` again until there are not red lines
+4) Edit rst files and add some meaningfull content there
+
+> **Note**
+> This can (should) be merged as is without doc-string fixes in the code or changes in templates. All additional improvements on API documentation should be made in new PRs.
+
+> **Warning**
+> You need to add new dependencies to use it. Run `create_venv`.
+
+Connected to #2490
+___
+
+
+
+
+
+Global: custom location for OP local versions #4673
+
+This provides configurable location to unzip Openpype version zips. By default, it was hardcoded to artist's app data folder, which might be problematic/slow with roaming profiles.Location must be accessible by user running OP Tray with write permissions (so `Program Files` might be problematic)
+
+
+___
+
+
+
+
+
+AYON: Update settings conversion #4837
+
+Updated conversion script of AYON settings to v3 settings. PR is related to changes in addons repository https://github.com/ynput/ayon-addons/pull/6 . Changed how the conversion happens -> conversion output does not start with openpype defaults but as empty dictionary.
+
+
+___
+
+
+
+
+
+AYON: Implement integrate links publish plugin #4842
+
+Implemented entity links get/create functions. Added new integrator which replaces v3 integrator for links.
+
+
+___
+
+
+
+
+
+General: Version attributes integration #4991
+
+Implemented unified integrate plugin to update version attributes after all integrations for AYON. The goal is to be able update attribute values in a unified way to a version when all addon integrators are done, so e.g. ftrack can add ftrack id to matching version in AYON server etc.The can be stored under `"versionAttributes"` key.
+
+
+___
+
+
+
+
+
+AYON: Staging versions can be used #4992
+
+Added ability to use staging versions in AYON mode.
+
+
+___
+
+
+
+
+
+AYON: Preparation for products #5038
+
+Prepare ayon settings conversion script for `product` settings conversion.
+
+
+___
+
+
+
+
+
+Loader: Hide inactive versions in UI #5101
+
+Added support for `active` argument to hide versions with active set to False in Loader UI when in AYON mode.
+
+
+___
+
+
+
+
+
+General: CLI addon command #5109
+
+Added `addon` alias for `module` in OpenPype cli commands.
+
+
+___
+
+
+
+
+
+AYON: OpenPype as server addon #5199
+
+OpenPype repository can be converted to AYON addon for distribution. Addon has defined dependencies that are required to use it and are not in base ayon-launcher (desktop application).
+
+
+___
+
+
+
+
+
+General: Runtime dependencies #5206
+
+Defined runtime dependencies in pyproject toml. Moved python ocio and otio modules there.
+
+
+___
+
+
+
+
+
+AYON: Bundle distribution #5209
+
+Since AYON server 0.3.0 are addon versions defined by bundles which affects how addons, dependency packages and installers are handled. Only source of truth, about any version of anything that should be used, is server bundle.
+
+
+___
+
+
+
+
+
+Feature/blender handle q application #5264
+
+This edit is to change the way the QApplication is run for Blender. It calls in the singleton (QApplication) during the register. This is made so that other Qt applications and addons are able to run on Blender. In its current implementation, if a QApplication is already running, all functionality of OpenPype becomes unavailable.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+General: Connect to AYON server (base) #3924
+
+Initial implementation of being able use AYON server in current OpenPype client. Added ability to connect to AYON server and use base queries.
+
+AYON mode has it's own executable (and start script). To start in AYON mode just replace `start.py` with `ayon_start.py` (added tray start script to tools). Added constant `AYON_SERVER_ENABLED` to `openpype/__init__.py` to know if ayon mode is enabled. In that case Mongo is not used at all and any attempts will cause crashes.I had to modify `~/openpype/client` content to be able do this switch. Mongo implementation was moved to `mongo` subfolder and use "star imports" in files from where current imports are used. Logic of any tool or query in code was not changed at all. Since functions were based on mongo queries they don't use full potential of AYON server abilities.ATM implementation has login UI, distribution of files from server and replacement of mongo queries. For queries is used `ayon_api` module. Which is in live development so the versions may change from day to day.
+
+
+___
+
+
+
+
+
+Enhancement kitsu note with exceptions #4537
+
+Adding a setting to choose some exceptions to IntegrateKitsuNote task status changes.
+
+
+___
+
+
+
+
+
+General: Environment variable for default OCIO configs #4670
+
+Define environment variable which lead to root of builtin ocio configs to be able change the root without changing settings. For the path in settings was used `"{OPENPYPE_ROOT}/vendor/bin/ocioconfig/OpenColorIOConfig"` which disallow to change the root somewhere else. That will be needed in AYON where configs won't be part of desktop application but downloaded from server.
+
+
+___
+
+
+
+
+
+AYON: Editorial hierarchy creation #4699
+
+Implemented extract hierarchy to AYON plugin which created entities in AYON using ayon api.
+
+
+___
+
+
+
+
+
+AYON: Vendorize ayon api #4753
+
+Vendorize ayon api into openpype vendor directory. The reason is that `ayon-python-api` is in live development and will fix/add features often in next few weeks/months, and because update of dependency requires new release -> new build, we want to avoid the need of doing that as it would affect OpenPype development.
+
+
+___
+
+
+
+
+
+General: Update PySide 6 for MacOs #4764
+
+New version of PySide6 does not have issues with settings UI. It is still breaking UI stylesheets so it is not changed for other plaforms but it is enhancement from previous state.
+
+
+___
+
+
+
+
+
+General: Removed unused cli commands #4902
+
+Removed `texturecopy` and `launch` cli commands from cli commands.
+
+
+___
+
+
+
+
+
+AYON: Linux & MacOS launch script #4970
+
+Added shell script to launch tray in AYON mode.
+
+
+___
+
+
+
+
+
+General: Qt scale enhancement #5059
+
+Set ~~'QT_SCALE_FACTOR_ROUNDING_POLICY'~~ scale factor rounding policy of QApplication to `PassThrough` so the scaling can be 'float' number and not just 'int' (150% -> 1.5 scale).
+
+
+___
+
+
+
+
+
+CI: WPS linting instead of Hound (rebase) 2 #5115
+
+Because Hound currently used to lint the code on GH ships with really old flake8 support, it fails miserably on any newer Python syntax. This PR is adding WPS linter to GitHub workflows that should step in.
+
+
+___
+
+
+
+
+
+Max: OP parameters only displays what is attached to the container #5229
+
+The OP parameter in 3dsmax only displays what is currently attached to the container while deleting while you can see the items which is not added when you are adding to the container.
+
+
+___
+
+
+
+
+
+Testing: improving logging during testing #5271
+
+Unit testing logging was crashing on more then one nested layers of inherited loggers.
+
+
+___
+
+
+
+
+
+Nuke: removing deprecated settings in baking #5275
+
+Removing deprecated settings for baking with reformat. This option was only for single reformat node and it had been substituted with multiple reposition nodes.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+AYON: General fixes and updates #4975
+
+Few smaller fixes related to AYON connection. Some of fixes were taken from this PR.
+
+
+___
+
+
+
+
+
+Start script: Change returncode on validate or list versions #4515
+
+Change exit code from `1` to `0` when versions are printed or when version is validated.
+
+Return code `1` is indicating error but there didn't happen any error.
+
+
+___
+
+
+
+
+
+AYON: Change login UI works #4754
+
+Fixed change of login UI. Logic change UI did show up, new login was successful, but after restart was used the previous login. This change fix the issue.
+
+
+___
+
+
+
+
+
+AYON: General issues #4763
+
+Vendorized `ayon_api` from PR broke OpenPype launch, because `ayon_api` is not available. Moved `ayon_api` from ayon specific subforlder to `common` python vendor in OpenPype, and removed login in ayon start script (which was invalid anyway). Also made fixed compatibility with PySide6 by using `qtpy` instead of `Qt` and changing code which is not PySide6 compatible.
+
+
+___
+
+
+
+
+
+AYON: Small fixes #4841
+
+Bugsfixes and enhancements related to AYON logic. Define `BUILTIN_OCIO_ROOT` environment variable so OCIO configs are working. Use constants from ayon api instead of hardcoding them in codebase. Change process name from "openpype" to "ayon". Don't execute login dialog when application is not yet running but use `open` method instead. Fixed missing modules settings which were not taken from openpype defaults. Updated ayon api to `0.1.17`.
+
+
+___
+
+
+
+
+
+Bugfix - Update gazu to 0.9.3 #4845
+
+This updates Gazu to 0.9.3 to make sure Gazu works with Kitsu and Zou 0.16.x+
+
+
+___
+
+
+
+
+
+Igniter: fix error reports in silent mode #4909
+
+Some errors in silent mode commands in Igniter were suppressed and not visible for example in Deadline log.
+
+
+___
+
+
+
+
+
+General: Remove ayon api from poetry lock #4964
+
+Remove AYON python api from pyproject.toml and poetry.lock again.
+
+
+___
+
+
+
+
+
+Ftrack: Fix AYON settings conversion #4967
+
+Fix conversion of ftrack settings in AYON mode.
+
+
+___
+
+
+
+
+
+AYON: ISO date format conversion issues #4981
+
+Function `datetime.fromisoformat` was replaced with `arrow.get` to be used instead.
+
+
+___
+
+
+
+
+
+AYON: Missing files on representations #4989
+
+Fix integration of files into representation in server database.
+
+
+___
+
+
+
+
+
+General: Fix Python 2 vendor for arrow #4993
+
+Moved remaining dependencies for arrow from ftrack to python 2 vendor.
+
+
+___
+
+
+
+
+
+General: Fix new load plugins for next minor relase #5000
+
+Fix access to `fname` attribute which is not available on load plugin anymore.
+
+
+___
+
+
+
+
+
+General: Fix mongo secure connection #5031
+
+Fix `ssl` and `tls` keys checks in mongo uri query string.
+
+
+___
+
+
+
+
+
+AYON: Fix site sync settings #5069
+
+Fixed settings for AYON variant of sync server.
+
+
+___
+
+
+
+
+
+General: Replace deprecated keyword argument in PyMongo #5080
+
+Use argument `tlsCAFile` instead of `ssl_ca_certs` to avoid deprecation warnings.
+
+
+___
+
+
+
+
+
+Igniter: QApplication is created #5081
+
+Function `_get_qt_app` actually creates new `QApplication` if was not created yet.
+
+
+___
+
+
+
+
+
+General: Lower unidecode version #5090
+
+Use older version of Unidecode module to support Python 2.
+
+
+___
+
+
+
+
+
+General: Lower cryptography to 39.0.0 #5099
+
+Lower cryptography to 39.0.0 to avoid breaking of DCCs like Maya and Nuke.
+
+
+___
+
+
+
+
+
+AYON: Global environments key fix #5118
+
+Seems that when converting ayon settings to OP settings the `environments` setting is put under the `environments` key in `general` however when populating the environment the `environment` key gets picked up, which does not contain the environment variables from the `core/environments` setting
+
+
+___
+
+
+
+
+
+Add collector to tray publisher for getting frame range data #5152
+
+Add collector to tray publisher to get frame range data. User can choose to enable this collector if they need this in the publisher.Resolve #5136
+
+
+___
+
+
+
+
+
+Unreal: get current project settings not using unreal project name #5170
+
+There was a bug where Unreal project name was used to query project settings. But Unreal project name can differ from the "real" one because of naming convention rules set by Unreal. This is fixing it by asking for current project settings.
+
+
+___
+
+
+
+
+
+Substance Painter: Fix Collect Texture Set Images unable to copy.deepcopy due to QMenu #5238
+
+Fix `copy.deepcopy` of `instance.data`.
+
+
+___
+
+
+
+
+
+Ayon: server returns different key #5251
+
+Package returned from server has `filename` instead of `name`.
+
+
+___
+
+
+
+
+
+Substance Painter: Fix default color management settings #5259
+
+The default settings for color management for Substance Painter were invalid, it was set to override the global config by default but specified no valid config paths of its own - and thus errored that the paths were not correct.This sets the defaults correctly to match other hosts._I quickly checked - this seems to be the only host with the wrong default settings_
+
+
+___
+
+
+
+
+
+Nuke: fixing container data if windows path in value #5267
+
+Windows path in container data are reformatted. Previously it was reported that Nuke was rising `utf8 0xc0` error if backward slashes were in data values.
+
+
+___
+
+
+
+
+
+Houdini: fix typo error in collect arnold rop #5281
+
+Fixing a typo error in `collect_arnold_rop.py`Reference: #5280
+
+
+___
+
+
+
+
+
+Slack - enhanced logging and protection against failure #5287
+
+Covered issues found in production on customer site. SlackAPI exception doesn't need to have 'error', covered uncaught exception.
+
+
+___
+
+
+
+
+
+Maya: Removed unnecessary import of pyblish.cli #5292
+
+This import resulted in adding additional logging handler which lead to duplication of logs in hosts with plugins containing `is_in_tests` method. Import is unnecessary for testing functionality.
+
+
+___
+
+
+
+### **🔀 Refactored code**
+
+
+
+Loader: Remove `context` argument from Loader.__init__() #4602
+
+Remove the previously required `context` argument.
+
+
+___
+
+
+
+
+
+Global: Remove legacy integrator #4786
+
+Remove the legacy integrator.
+
+
+___
+
+
+
+### **📃 Documentation**
+
+
+
+Next Minor Release #5291
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+Maya: Refactor to new publisher #4388
+
+**Refactor Maya to use the new publisher with new creators.**
+
+
+- [x] Legacy instance can be converted in UI using `SubsetConvertorPlugin`
+- [x] Fix support for old style "render" and "vrayscene" instance to the new per layer format.
+- [x] Context data is stored with scene
+- [x] Workfile instance converted to AutoCreator
+- [x] Converted Creator classes
+- [x] Create animation
+- [x] Create ass
+- [x] Create assembly
+- [x] Create camera
+- [x] Create layout
+- [x] Create look
+- [x] Create mayascene
+- [x] Create model
+- [x] Create multiverse look
+- [x] Create multiverse usd
+- [x] Create multiverse usd comp
+- [x] Create multiverse usd over
+- [x] Create pointcache
+- [x] Create proxy abc
+- [x] Create redshift proxy
+- [x] Create render
+- [x] Create rendersetup
+- [x] Create review
+- [x] Create rig
+- [x] Create setdress
+- [x] Create unreal skeletalmesh
+- [x] Create unreal staticmesh
+- [x] Create vrayproxy
+- [x] Create vrayscene
+- [x] Create xgen
+- [x] Create yeti cache
+- [x] Create yeti rig
+- [ ] Tested new Creator publishes
+- [x] Publish animation
+- [x] Publish ass
+- [x] Publish assembly
+- [x] Publish camera
+- [x] Publish layout
+- [x] Publish look
+- [x] Publish mayascene
+- [x] Publish model
+- [ ] Publish multiverse look
+- [ ] Publish multiverse usd
+- [ ] Publish multiverse usd comp
+- [ ] Publish multiverse usd over
+- [x] Publish pointcache
+- [x] Publish proxy abc
+- [x] Publish redshift proxy
+- [x] Publish render
+- [x] Publish rendersetup
+- [x] Publish review
+- [x] Publish rig
+- [x] Publish setdress
+- [x] Publish unreal skeletalmesh
+- [x] Publish unreal staticmesh
+- [x] Publish vrayproxy
+- [x] Publish vrayscene
+- [x] Publish xgen
+- [x] Publish yeti cache
+- [x] Publish yeti rig
+- [x] Publish workfile
+- [x] Rig loader correctly generates a new style animation creator instance
+- [ ] Validations / Error messages for common validation failures look nice and usable as a report.
+- [ ] Make Create Animation hidden to the user (should not create manually?)
+- [x] Correctly detect difference between **'creator_attributes'** and **'instance_data'** since both are "flattened" to the top node.
+
+
+___
+
+
+
+
+
+Start script: Fix possible issues with destination drive path #4478
+
+Drive paths for windows are fixing possibly missing slash at the end of destination path.
+
+Windows `subst` command require to have destination path with slash if it's a drive (it should be `G:\` not `G:`).
+
+
+___
+
+
+
+
+
+Global: Move PyOpenColorIO to vendor/python #4946
+
+So that DCCs don't conflict with their own.
+
+See https://github.com/ynput/OpenPype/pull/4267#issuecomment-1537153263 for the issue with Gaffer.
+
+I'm not sure if this is the correct approach, but I assume PySide/Shiboken is under `vendor/python` for this reason as well...
+___
+
+
+
+
+
+RuntimeError with Click on deadline publish #5065
+
+I changed Click to version 8.0 instead of 7.1.2 to solve this error:
+```
+2023-05-30 16:16:51: 0: STDOUT: Traceback (most recent call last):
+2023-05-30 16:16:51: 0: STDOUT: File "start.py", line 1126, in boot
+2023-05-30 16:16:51: 0: STDOUT: File "/prod/softprod/apps/openpype/LINUX/3.15/dependencies/click/core.py", line 829, in __call__
+2023-05-30 16:16:51: 0: STDOUT: return self.main(*args, **kwargs)
+2023-05-30 16:16:51: 0: STDOUT: File "/prod/softprod/apps/openpype/LINUX/3.15/dependencies/click/core.py", line 760, in main
+2023-05-30 16:16:51: 0: STDOUT: _verify_python3_env()
+2023-05-30 16:16:51: 0: STDOUT: File "/prod/softprod/apps/openpype/LINUX/3.15/dependencies/click/_unicodefun.py", line 126, in _verify_python3_env
+2023-05-30 16:16:51: 0: STDOUT: raise RuntimeError(
+2023-05-30 16:16:51: 0: STDOUT: RuntimeError: Click will abort further execution because Python 3 was configured to use ASCII as encoding for the environment. Consult https://click.palletsprojects.com/python3/ for mitigation steps.
+```
+
+
+___
+
+
+
+
+
+
+## [3.15.12](https://github.com/ynput/OpenPype/tree/3.15.12)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.15.11...3.15.12)
+
+### **🆕 New features**
+
+
+
+Tray Publisher: User can set colorspace per instance explicitly #4901
+
+With this feature a user can set/override the colorspace for the representations of an instance explicitly instead of relying on the File Rules from project settings or alike. This way you can ingest any file and explicitly say "this file is colorspace X".
+
+
+___
+
+
+
+
+
+Review Family in Max #5001
+
+Review Feature by creating preview animation in 3dsmax(The code is still cleaning up so there is going to be some updates until it is ready for review)
+
+
+___
+
+
+
+
+
+AfterEffects: support for workfile template builder #5163
+
+This PR add functionality of templated workfile builder. It allows someone to prepare AE workfile with placeholders as for automatically loading particular representation of particular subset of particular asset from context where workfile is opened.Selection from multiple prepared workfiles is provided with usage of templates, specific type of tasks could use particular workfile template etc.Artists then can build workfile from template when opening new workfile.
+
+
+___
+
+
+
+
+
+CreatePlugin: Get next version helper #5242
+
+Implemented helper functions to get next available versions for create instances.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Maya: Improve Templates #4854
+
+Use library method for fetching reference node and support parent in hierarchy.
+
+
+___
+
+
+
+
+
+Bug: Maya - xgen sidecar files arent moved when saving workfile as an new asset workfile changing context - OP-6222 #5215
+
+This PR manages the Xgen files when switching context in the Workfiles app.
+
+
+___
+
+
+
+
+
+node references to check for duplicates in Max #5192
+
+No duplicates for node references in Max when users trying to select nodes before publishing
+
+
+___
+
+
+
+
+
+Tweak profiles logging to debug level #5194
+
+Tweak profiles logging to debug level since they aren't artist facing logs.
+
+
+___
+
+
+
+
+
+Enhancement: Reduce more visual clutter for artists in new publisher reports #5208
+
+Got this from one of our artists' reports - figured some of these logs were definitely not for the artist, reduced those logs to debug level.
+
+
+___
+
+
+
+
+
+Cosmetics: Tweak pyblish repair actions (icon, logs, docstring) #5213
+
+- Add icon to RepairContextAction
+- logs to debug level
+- also add attempt repair for RepairAction for consistency
+- fix RepairContextAction docstring to mention correct argument name
+
+#### Additional info
+
+We should not forget to remove this ["deprecated" actions.py file](https://github.com/ynput/OpenPype/blob/3501d0d23a78fbaef106da2fffe946cb49bef855/openpype/action.py) in 3.16 (next-minor)
+
+## Testing notes:
+
+1. Run some fabulous repairs!
+
+___
+
+
+
+
+
+Maya: fix save file prompt on launch last workfile with color management enabled + restructure `set_colorspace` #5225
+
+- Only set `configFilePath` when OCIO env var is not set since it doesn't do anything if OCIO var is set anyway.
+- Set the Maya 2022+ default OCIO path using the resources path instead of "" to avoid Maya Save File on new file after launch
+- **Bugfix: This is what fixes the Save prompt on open last workfile feature with Global color management enabled**
+- Move all code related to applying the maya settings together after querying the settings
+- Swap around the `if use_workfile_settings` since the check was reversed
+- Use `get_current_project_name()` instead of environment vars
+
+
+___
+
+
+
+
+
+Enhancement: More descriptive error messages for Loaders #5227
+
+Tweak raised errors and error messages for loader errors.
+
+
+___
+
+
+
+
+
+Houdini: add select invalid action for ValidateSopOutputNode #5231
+
+This PR adds `SelectROPAction` action to `houdini\api\action.py`and it's used in `Validate Output Node``SelectROPAction` is used to select the associated ROPs with the errored instances.
+
+
+___
+
+
+
+
+
+Remove new lines from the delivery template string #5235
+
+If the delivery template has a new line symbol at the end, say it was copied from the text editor, the delivery process will fail with `OSError` due to incorrect destination path. To avoid that I added `rstrip()` to the `delivery_path` processing.
+
+
+___
+
+
+
+
+
+Houdini: better selection on pointcache creation #5250
+
+Houdini allows `ObjNode` path as `sop_path` in the `ROP` unlike OP/ Ayon require `sop_path` to be set to a sop node path explicitly In this code, better selection is used to filter out invalid selections from OP/ Ayon point of viewValid selections are
+- `SopNode` that has parent of type `geo` or `subnet`
+- `ObjNode` of type `geo` that has
+- `SopNode` of type `output`
+- `SopNode` with render flag `on` (if no `Sopnode` of type `output`)this effectively filter
+- empty `ObjNode`
+- `ObjNode`(s) of other types like `cam` and `dopnet`
+- `SopNode`(s) that thier parents of other types like `cam` and `sop solver`
+
+
+___
+
+
+
+
+
+Update scene inventory even if any errors occurred during update #5252
+
+When selecting many items in the scene inventory to update versions and one of the items would error out the updating stops. However, before this PR the scene inventory would also NOT refresh making you think it did nothing.Also implemented as method to allow some code deduplication.
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+Maya: Convert frame values to integers #5188
+
+Convert frame values to integers.
+
+
+___
+
+
+
+
+
+Maya: fix the register_event_callback correctly collecting workfile save after #5214
+
+fixing the bug of register_event_callback not being able to collect action of "workfile_save_after" for lock file action
+
+
+___
+
+
+
+
+
+Maya: aligning default settings to distributed aces 1.2 config #5233
+
+Maya colorspace setttings defaults are set the way they align our distributed ACES 1.2 config file set in global colorspace configs.
+
+
+___
+
+
+
+
+
+RepairAction and SelectInvalidAction filter instances failed on the exact plugin #5240
+
+RepairAction and SelectInvalidAction actually filter to instances that failed on the exact plugin - not on "any failure"
+
+
+___
+
+
+
+
+
+Maya: Bugfix look update nodes by id with non-unique shape names (query with `fullPath`) #5257
+
+Fixes a bug where updating attributes on nodes with assigned shader if shape name existed more than once in the scene due to `cmds.listRelatives` call not being done with the `fullPath=True` flag.Original error:
+```python
+# Traceback (most recent call last):
+# File "E:\openpype\OpenPype\openpype\tools\sceneinventory\view.py", line 264, in
+# lambda: self._show_version_dialog(items))
+# File "E:\openpype\OpenPype\openpype\tools\sceneinventory\view.py", line 722, in _show_version_dialog
+# self._update_containers(items, version)
+# File "E:\openpype\OpenPype\openpype\tools\sceneinventory\view.py", line 849, in _update_containers
+# update_container(item, item_version)
+# File "E:\openpype\OpenPype\openpype\pipeline\load\utils.py", line 502, in update_container
+# return loader.update(container, new_representation)
+# File "E:\openpype\OpenPype\openpype\hosts\maya\plugins\load\load_look.py", line 119, in update
+# nodes_by_id[lib.get_id(n)].append(n)
+# File "E:\openpype\OpenPype\openpype\hosts\maya\api\lib.py", line 1420, in get_id
+# sel.add(node)
+```
+
+
+___
+
+
+
+
+
+Nuke: Create nodes with inpanel=False #5051
+
+This PR is meant to remove the annoyance of the UI changing focus to the properties window just for the property window of the newly created node to disappear. Instead of using node.hideControlPanel I'm implementing the concealment during the creation of the node which will not change the focus of the current window.
+___
+
+
+
+
+
+Fix the reset frame range not setting up the right timeline in Max #5187
+
+Resolve #5181
+
+
+___
+
+
+
+
+
+Resolve: after launch automatization fixes #5193
+
+Workfile is no correctly created and aligned witch actual project. Also the launching mechanism is now fixed so even no workfile had been saved yet it will open OpenPype menu automatically.
+
+
+___
+
+
+
+
+
+General: Revert backward incompatible change of path to template to multiplatform #5197
+
+Now platformity is still handed by usage of `work[root]` (or any other root that is accessible across platforms.)
+
+
+___
+
+
+
+
+
+Nuke: root set format updating in node graph #5198
+
+Nuke root node needs to be reset on some values so any knobs could be updated in node graph. This works the same way as an user would change frame number so expressions would update its values in knobs.
+
+
+___
+
+
+
+
+
+Hiero: fixing otio current project and cosmetics #5200
+
+Otio were not returning correct current project once additional Untitled project was open in project manager stack.
+
+
+___
+
+
+
+
+
+Max: Publisher instances dont hold its enabled disabled states when Publisher reopened again #5202
+
+Resolve #5183, general maxscript conversion issue to python (e.g. bool conversion, true in maxscript while True in Python)(Also resolve the ValueError when you change the subset to publish into list view menu)
+
+
+___
+
+
+
+
+
+Burnins: Filter script is defined only for video streams #5205
+
+Burnins are working for inputs with audio.
+
+
+___
+
+
+
+
+
+Colorspace lib fix compatible python version comparison #5212
+
+Fix python version comparison.
+
+
+___
+
+
+
+
+
+Houdini: Fix `get_color_management_preferences` #5217
+
+Fix the issue described here where the logic for retrieving the current OCIO display and view was incorrectly trying to apply a regex to it.
+
+
+___
+
+
+
+
+
+Houdini: Redshift ROP image format bug #5218
+
+Problem :
+"RS_outputFileFormat" parm value was missing
+and there were more "image_format" than redshift rop supports
+
+Fix:
+1) removed unnecessary formats from `image_format_enum`
+2) add the selected format value to `RS_outputFileFormat`
+___
+
+
+
+
+
+Colorspace: check PyOpenColorIO rather then python version #5223
+
+Fixing previously merged PR (https://github.com/ynput/OpenPype/pull/5212) And applying better way to check compatibility with PyOpenColorIO python api.
+
+
+___
+
+
+
+
+
+Validate delivery action representations status #5228
+
+- disable delivery button if no representations checked
+- fix macos combobox layout
+- add error message if no delivery templates found
+
+
+___
+
+
+
+
+
+ Houdini: Add geometry check for pointcache family #5230
+
+When `sop_path` on ABC ROP node points to a non `SopNode`, these validators `validate_abc_primitive_to_detail.py`, `validate_primitive_hierarchy_paths.py` will error and crash when this line is executed `geo = output_node.geometryAtFrame(frame)`
+
+
+___
+
+
+
+
+
+Houdini: Add geometry check for VDB family #5232
+
+When `sop_path` on Geometry ROP node points to a non SopNode, this validator `validate_vdb_output_node.py` will error and crash when this line is executed`sop_node.geometryAtFrame(frame)`
+
+
+___
+
+
+
+
+
+Substance Painter: Include the setting only in publish tab #5234
+
+Instead of having two settings in both create and publish tab, there is solely one setting in the publish tab for users to set up the parameters.Resolve #5172
+
+
+___
+
+
+
+
+
+Maya: Fix collecting arnold prefix when none #5243
+
+When no prefix is specified in render settings, the renderlayer collector would error.
+
+
+___
+
+
+
+
+
+Deadline: OPENPYPE_VERSION should only be added when running from build #5244
+
+When running from source the environment variable `OPENPYPE_VERSION` should not be added. This is a bugfix for the feature #4489
+
+
+___
+
+
+
+
+
+Fix no prompt for "unsaved changes" showing when opening workfile in Houdini #5246
+
+Fix no prompt for "unsaved changes" showing when opening workfile in Houdini.
+
+
+___
+
+
+
+
+
+Fix no prompt for "unsaved changes" showing when opening workfile in Substance Painter #5248
+
+Fix no prompt for "unsaved changes" showing when opening workfile in Substance Painter.
+
+
+___
+
+
+
+
+
+General: add the os library before os.environ.get #5249
+
+Adding os library into `creator_plugins.py` due to `os.environ.get` in line 667
+
+
+___
+
+
+
+
+
+Maya: Fix set_attribute for enum attributes #5261
+
+Fix for #5260
+
+
+___
+
+
+
+
+
+Unreal: Move Qt imports away from module init #5268
+
+Importing `Window` creates errors in headless mode.
+```
+*** WRN: >>> { ModulesLoader }: [ FAILED to import host folder unreal ]
+=============================
+No Qt bindings could be found
+=============================
+Traceback (most recent call last):
+ File "C:\Users\tokejepsen\OpenPype\.venv\lib\site-packages\qtpy\__init__.py", line 252, in
+ from PySide6 import __version__ as PYSIDE_VERSION # analysis:ignore
+ModuleNotFoundERROR: No module named 'PySide6'
+
+During handling of the above exception, another exception occurred:
+
+Traceback (most recent call last):
+ File "C:\Users\tokejepsen\OpenPype\openpype\modules\base.py", line 385, in _load_modules
+ default_module = __import__(
+ File "C:\Users\tokejepsen\OpenPype\openpype\hosts\unreal\__init__.py", line 1, in
+ from .addon import UnrealAddon
+ File "C:\Users\tokejepsen\OpenPype\openpype\hosts\unreal\addon.py", line 4, in
+ from openpype.widgets.message_window import Window
+ File "C:\Users\tokejepsen\OpenPype\openpype\widgets\__init__.py", line 1, in
+ from .password_dialog import PasswordDialog
+ File "C:\Users\tokejepsen\OpenPype\openpype\widgets\password_dialog.py", line 1, in
+ from qtpy import QtWidgets, QtCore, QtGui
+ File "C:\Users\tokejepsen\OpenPype\.venv\lib\site-packages\qtpy\__init__.py", line 259, in
+ raise QtBindingsNotFoundERROR()
+qtpy.QtBindingsNotFoundERROR: No Qt bindings could be found
+```
+
+
+___
+
+
+
+### **🔀 Refactored code**
+
+
+
+Maya: Minor refactoring and code cleanup #5226
+
+Some small cleanup and refactoring of logic. Removing old comments, unused imports and some minor optimization. Also removed the prints of the loader names of each container the scene in `fix_incompatible_containers` + optimizing by using `set` and defining only once. Moved some UI related code/tweaks to run `on_init` only if not in headless mode. Removed an empty `obj.py` file.Each commit message kind of describes why the change was made.
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+Bug: Template builder fails when loading data without outliner representation #5222
+
+I add an assertion management in case the container does not have a represention in outliner.
+
+
+___
+
+
+
+
+
+AfterEffects - add container check validator to AE settings #5203
+
+Adds check if scene contains only latest version of loaded containers.
+
+
+___
+
+
+
+
+
+
+## [3.15.11](https://github.com/ynput/OpenPype/tree/3.15.11)
+
+
+[Full Changelog](https://github.com/ynput/OpenPype/compare/3.15.10...3.15.11)
+
+### **🆕 New features**
+
+
+
+Ftrack: Task status during publishing #5123
+
+Added option to change task status during publishing for 3 possible cases: "sending to farm", "local integration" and "on farm integration".
+
+
+___
+
+
+
+
+
+Nuke: Allow for more complex temp rendering paths #5132
+
+When changing the temporary rendering template (i.e., add `{asset}` to the path) to something a bit more complex the formatting was erroring due to missing keys.
+
+
+___
+
+
+
+
+
+Blender: Add support for custom path for app templates #5137
+
+This PR adds support for a custom App Templates path in Blender by setting the `BLENDER_USER_SCRIPTS` environment variable to the path specified in `OPENPYPE_APP_TEMPLATES_PATH`. This allows users to use their own custom app templates in Blender.
+
+
+___
+
+
+
+
+
+TrayPublisher & StandalonePublisher: Specify version #5142
+
+Simple creators in TrayPublisher can affect which version will be integrated. Standalone publisher respects the version change from UI.
+
+
+___
+
+
+
+### **🚀 Enhancements**
+
+
+
+Workfile Builder UI: Workfile builder window is not modal #5131
+
+Workfile Templates Builder:
+- Create dialog is not a modal dialog
+- Create dialog remains open after create, so you can directly create a new placeholder with similar settings
+- In Maya allow to create root level placeholders (no selection during create) - **this felt more like a bugfix than anything else.**
+
+
+___
+
+
+
+
+
+3dsmax: Use custom modifiers to hold instance members #4931
+
+Moving logic to handle members of publishing instance from children/parent relationship on Container to tracking via custom attribute on modifier. This eliminates limitations where you couldn't have one node multiple times under one Container and because it stores those relationships as weak references, they are easily transferable even when original nodes are renamed.
+
+
+___
+
+
+
+
+
+Add height, width and fps setup to project manager #5075
+
+Add Width, Height, FPS, Pixel Aspect and Frame Start/End to the Project creation dialogue in the Project Manager.I understand that the Project manager will be replaced in the upcoming Ayon, but for the time being I believe setting new project with these options available would be more fun.
+
+
+___
+
+
+
+
+
+Nuke: connect custom write node script to the OP setting #5113
+
+Allows user to customize the values of knobs attribute in the OP setting and use it in custom write node
+
+
+___
+
+
+
+
+
+Keep `publisher.create_widget` variant when creating subsets #5119
+
+Whenever a person is creating a subset to publish, the "creator" widget resets (where you choose the variant, product, etc.) so if the person is publishing several images of the a variant which is not the default one, they have to keep selecting the correct one after every "create".
+
+This commit resets the original variant upon successful creation of a subset for publishing.
+
+Demo:
+[Screencast from 2023-06-08 10-46-40.webm](https://github.com/ynput/OpenPype/assets/1800151/ca1c91d4-b8f3-43d2-a7b7-35987f5b6a3f)
+
+## Testing notes:
+1. Launch AYON/OP
+2. Launch the publisher (select a project, shot, etc.)
+3. Crete a publish type (any works)
+4. Choose a variant for the publish that is not the default
+5. "Create >>"
+
+The Variant fields should still have the variant you choose.
+
+
+
+___
+
+
+
+
+
+Color Management- added color management support for simple expected files on Deadline #5122
+
+Running of `ExtractOIIOTranscode` during Deadline publish was previously implemented only on DCCs with AOVs (Maya, Max).This PR extends this for other DCCs with flat structure of expected files.
+
+
+___
+
+
+
+
+
+hide macos dock icon on build #5133
+
+Set `LSUIElement` to `1` in the `Info.plist` to hide OP icon from the macos dock by default.
+
+
+___
+
+
+
+
+
+Pack project: Raise exception with reasonable message #5145
+
+Pack project crashes with relevant message when destination directory is not set.
+
+
+___
+
+
+
+
+
+Allow "inventory" actions to be supplied by a Module/Addon. #5146
+
+Adds "inventory" as a possible key to the plugin paths to be returned from a module.
+
+
+___
+
+
+
+
+
+3dsmax: make code compatible with 3dsmax 2022 #5164
+
+Python 3.7 in 3dsmax 2022 is not supporting walrus operator. This is removing it from the code for the sake of compatibility
+
+
+___
+
+
+
+### **🐛 Bug fixes**
+
+
+
+Maya: Support same attribute names on different node types. #5054
+
+When validating render settings attributes, support same attribute names on different node types.
+
+
+___
+
+
+
+
+
+Maya: bug fix the standin being not loaded when they are first loaded #5143
+
+fix the bug of raising error when the first two standins are loaded through the loaderThe bug mentioned in the related issue: https://github.com/ynput/OpenPype/issues/5129For some reason, `defaultArnoldRenderOptions.operator` is not listed in the connection node attribute even if `cmds.loadPlugin("mtoa", quiet=True)` executed before loading the object as standins for the first time.But if you manually turn on mtoa through plugin preference and load the standins for the first time, it won't raise the related `defaultArnoldRenderOptions.operator` error.
+
+
+___
+
+
+
+
+
+Maya: bug fix arnoldExportAss unable to export selected set members #5150
+
+See #5108 fix the bug arnoldExportAss being not able to export and error out during extraction.
+
+
+___
+
+
+
+
+
+Maya: Xgen multiple descriptions on single shape - OP-6039 #5160
+
+When having multiple descriptions on the same geometry, the extraction would produce redundant duplicate geometries.
+
+
+___
+
+
+
+
+
+Maya: Xgen export of Abc's during Render Publishing - OP-6206 #5167
+
+Shading assignments was missing duplicating the setup for Xgen publishing and the exporting of patches was getting the end frame incorrectly.
+
+
+___
+
+
+
+
+
+Maya: Include handles - OP-6236 #5175
+
+Render range was missing the handles.
+
+
+___
+
+
+
+
+
+OCIO: Support working with single frame renders #5053
+
+When there is only 1 file, the datamember `files` on the representation should be a string.
+
+
+___
+
+
+
+
+
+Burnins: Refactored burnins script #5094
+
+Refactored list value for burnins and fixed command length limit by using temp file for filters string.
+
+
+___
+
+
+
+
+
+Nuke: open_file function can open autosave script #5107
+
+Fix the bug of the workfile dialog being unable to open autosave nuke script
+
+
+___
+
+
+
+
+
+ImageIO: Minor fixes #5147
+
+Resolve few minor fixes related to latest image io changes from PR.
+
+
+___
+
+
+
+
+
+Publisher: Fix save shortcut #5148
+
+Save shortcut should work for both PySide2 and PySide6.
+
+
+___
+
+
+
+
+
+Pack Project: Fix files packing #5154
+
+Packing of project with files does work again.
+
+
+___
+
+
+
+
+
+Maya: Xgen version mismatch after publish - OP-6204 #5161
+
+Xgen was not updating correctly when for example adding or removing descriptions. This resolve the issue by overwritting the workspace xgen file.
+
+
+___
+
+
+
+
+
+Publisher: Edge case fixes #5165
+
+Fix few edge case issues that may cause issues in Publisher UI.
+
+
+___
+
+
+
+
+
+Colorspace: host config path backward compatibility #5166
+
+Old project settings overrides are now fully backward compatible. The issue with host config paths overrides were solved and now once a project used to be set to ocio_config **enabled** with found filepaths - this is now considered as activated host ocio_config paths overrides.Nuke is having an popup dialogue which is letting know to a user that settings for config path were changed.
+
+
+___
+
+
+
+
+
+Maya: import workfile missing - OP-6233 #5174
+
+Missing `workfile` family to import.
+
+
+___
+
+
+
+
+
+Ftrack: Fix ignore sync filter #5176
+
+Ftrack ignore filter does not crash because of dictionary modifications during it's iteration.
+
+
+___
+
+
+
+
+
+Webpublisher - headless publish shouldn't be blocking operation #5177
+
+`subprocess.call` was blocking, which resulted in UI non responsiveness as it was waiting for publish to finish.
+
+
+___
+
+
+
+
+
+Publisher: Fix disappearing actions #5184
+
+Pyblish plugin actions are visible as expected.
+
+
+___
+
+
+
+### **Merged pull requests**
+
+
+
+Enhancement:animation family loaded as standing (abc) uses "use file sequence" #5110
+
+The changes are the following. We started by updating the the is_sequence(files) function allowing it to return True for a list of files which has only one file, since our animation in this provides just one alembic file. For the correct FPS number, we got the fps from the published ass/abc from the version data.
+
+
+___
+
+
+
+
+
+add label to matching family #5128
+
+I added the possibility to filter the `family smart select` with the label in addition to the family.
+
+
+___
+
+
+
+
+
+
## [3.15.10](https://github.com/ynput/OpenPype/tree/3.15.10)
@@ -1551,7 +4893,7 @@ ___
Maya Load References - Add Display Handle Setting #4904
-When we load a reference in Maya using OpenPype loader, display handle is checked by default and prevent us to select easily the object in the viewport. I understand that some productions like to keep this option, so I propose to add display handle to the reference loader settings.
+When we load a reference in Maya using OpenPype loader, display handle is checked by default and prevent us to select easily the object in the viewport. I understand that some productions like to keep this option, so I propose to add display handle to the reference loader settings.
___
@@ -1659,7 +5001,7 @@ ___
Patchelf version locked #4853
-For Centos dockerfile it is necessary to lock the patchelf version to the older, otherwise the build process fails.
+For Centos dockerfile it is necessary to lock the patchelf version to the older, otherwise the build process fails.
___
diff --git a/Dockerfile.centos7 b/Dockerfile.centos7
index ce1a624a4f8..9217140f20f 100644
--- a/Dockerfile.centos7
+++ b/Dockerfile.centos7
@@ -32,12 +32,16 @@ RUN yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.n
wget \
gcc \
zlib-devel \
+ pcre-devel \
+ perl-core \
bzip2 \
bzip2-devel \
readline-devel \
sqlite sqlite-devel \
openssl-devel \
openssl-libs \
+ openssl11-devel \
+ openssl11-libs \
tk-devel libffi-devel \
patchelf \
automake \
@@ -71,7 +75,12 @@ RUN echo 'export PATH="$HOME/.pyenv/bin:$PATH"'>> $HOME/.bashrc \
&& echo 'eval "$(pyenv init -)"' >> $HOME/.bashrc \
&& echo 'eval "$(pyenv virtualenv-init -)"' >> $HOME/.bashrc \
&& echo 'eval "$(pyenv init --path)"' >> $HOME/.bashrc
-RUN source $HOME/.bashrc && pyenv install ${OPENPYPE_PYTHON_VERSION}
+RUN source $HOME/.bashrc \
+ && export CPPFLAGS="-I/usr/include/openssl11" \
+ && export LDFLAGS="-L/usr/lib64/openssl11 -lssl -lcrypto" \
+ && export PATH=/usr/local/openssl/bin:$PATH \
+ && export LD_LIBRARY_PATH=/usr/local/openssl/lib:$LD_LIBRARY_PATH \
+ && pyenv install ${OPENPYPE_PYTHON_VERSION}
COPY . /opt/openpype/
RUN rm -rf /openpype/.poetry || echo "No Poetry installed yet."
@@ -93,12 +102,13 @@ RUN source $HOME/.bashrc \
RUN source $HOME/.bashrc \
&& ./tools/fetch_thirdparty_libs.sh
+RUN echo 'export PYTHONPATH="/opt/openpype/vendor/python:$PYTHONPATH"'>> $HOME/.bashrc
RUN source $HOME/.bashrc \
&& bash ./tools/build.sh
RUN cp /usr/lib64/libffi* ./build/exe.linux-x86_64-3.9/lib \
- && cp /usr/lib64/libssl* ./build/exe.linux-x86_64-3.9/lib \
- && cp /usr/lib64/libcrypto* ./build/exe.linux-x86_64-3.9/lib \
+ && cp /usr/lib64/openssl11/libssl* ./build/exe.linux-x86_64-3.9/lib \
+ && cp /usr/lib64/openssl11/libcrypto* ./build/exe.linux-x86_64-3.9/lib \
&& cp /root/.pyenv/versions/${OPENPYPE_PYTHON_VERSION}/lib/libpython* ./build/exe.linux-x86_64-3.9/lib \
&& cp /usr/lib64/libxcb* ./build/exe.linux-x86_64-3.9/vendor/python/PySide2/Qt/lib
diff --git a/README.md b/README.md
index 8757e3db921..92f1cb62dc0 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
[](#contributors-)
OpenPype
-====
+========
[](https://github.com/pypeclub/pype/actions/workflows/documentation.yml) 
@@ -47,7 +47,7 @@ It can be built and ran on all common platforms. We develop and test on the foll
For more details on requirements visit [requirements documentation](https://openpype.io/docs/dev_requirements)
Building OpenPype
--------------
+-----------------
To build OpenPype you currently need [Python 3.9](https://www.python.org/downloads/) as we are following
[vfx platform](https://vfxplatform.com). Because of some Linux distros comes with newer Python version
@@ -67,9 +67,9 @@ git clone --recurse-submodules git@github.com:Pypeclub/OpenPype.git
#### To build OpenPype:
-1) Run `.\tools\create_env.ps1` to create virtual environment in `.\venv`
+1) Run `.\tools\create_env.ps1` to create virtual environment in `.\venv`.
2) Run `.\tools\fetch_thirdparty_libs.ps1` to download third-party dependencies like ffmpeg and oiio. Those will be included in build.
-3) Run `.\tools\build.ps1` to build OpenPype executables in `.\build\`
+3) Run `.\tools\build.ps1` to build OpenPype executables in `.\build\`.
To create distributable OpenPype versions, run `./tools/create_zip.ps1` - that will
create zip file with name `openpype-vx.x.x.zip` parsed from current OpenPype repository and
@@ -88,38 +88,38 @@ some OpenPype dependencies like [CMake](https://cmake.org/) and **XCode Command
Easy way of installing everything necessary is to use [Homebrew](https://brew.sh):
1) Install **Homebrew**:
-```sh
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-```
+ ```sh
+ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+ ```
2) Install **cmake**:
-```sh
-brew install cmake
-```
+ ```sh
+ brew install cmake
+ ```
3) Install [pyenv](https://github.com/pyenv/pyenv):
-```sh
-brew install pyenv
-echo 'eval "$(pyenv init -)"' >> ~/.zshrc
-pyenv init
-exec "$SHELL"
-PATH=$(pyenv root)/shims:$PATH
-```
-
-4) Pull in required Python version 3.9.x
-```sh
-# install Python build dependences
-brew install openssl readline sqlite3 xz zlib
-
-# replace with up-to-date 3.9.x version
-pyenv install 3.9.6
-```
-
-5) Set local Python version
-```sh
-# switch to OpenPype source directory
-pyenv local 3.9.6
-```
+ ```sh
+ brew install pyenv
+ echo 'eval "$(pyenv init -)"' >> ~/.zshrc
+ pyenv init
+ exec "$SHELL"
+ PATH=$(pyenv root)/shims:$PATH
+ ```
+
+4) Pull in required Python version 3.9.x:
+ ```sh
+ # install Python build dependences
+ brew install openssl readline sqlite3 xz zlib
+
+ # replace with up-to-date 3.9.x version
+ pyenv install 3.9.6
+ ```
+
+5) Set local Python version:
+ ```sh
+ # switch to OpenPype source directory
+ pyenv local 3.9.6
+ ```
#### To build OpenPype:
@@ -144,6 +144,10 @@ sudo ./tools/docker_build.sh centos7
If all is successful, you'll find built OpenPype in `./build/` folder.
+Docker build can be also started from Windows machine, just use `./tools/docker_build.ps1` instead of shell script.
+
+This could be used even for building linux build (with argument `centos7` or `debian`)
+
#### Manual build
You will need [Python >= 3.9](https://www.python.org/downloads/) and [git](https://git-scm.com/downloads). You'll also need [curl](https://curl.se) on systems that doesn't have one preinstalled.
@@ -241,7 +245,7 @@ pyenv local 3.9.6
Running OpenPype
-------------
+----------------
OpenPype can by executed either from live sources (this repository) or from
*"frozen code"* - executables that can be build using steps described above.
@@ -289,7 +293,7 @@ To run tests, execute `.\tools\run_tests(.ps1|.sh)`.
Developer tools
--------------
+---------------
In case you wish to add your own tools to `.\tools` folder without git tracking, it is possible by adding it with `dev_*` suffix (example: `dev_clear_pyc(.ps1|.sh)`).
diff --git a/common/openpype_common/distribution/README.md b/common/openpype_common/distribution/README.md
deleted file mode 100644
index 212eb267b83..00000000000
--- a/common/openpype_common/distribution/README.md
+++ /dev/null
@@ -1,18 +0,0 @@
-Addon distribution tool
-------------------------
-
-Code in this folder is backend portion of Addon distribution logic for v4 server.
-
-Each host, module will be separate Addon in the future. Each v4 server could run different set of Addons.
-
-Client (running on artist machine) will in the first step ask v4 for list of enabled addons.
-(It expects list of json documents matching to `addon_distribution.py:AddonInfo` object.)
-Next it will compare presence of enabled addon version in local folder. In the case of missing version of
-an addon, client will use information in the addon to download (from http/shared local disk/git) zip file
-and unzip it.
-
-Required part of addon distribution will be sharing of dependencies (python libraries, utilities) which is not part of this folder.
-
-Location of this folder might change in the future as it will be required for a clint to add this folder to sys.path reliably.
-
-This code needs to be independent on Openpype code as much as possible!
\ No newline at end of file
diff --git a/common/openpype_common/distribution/addon_distribution.py b/common/openpype_common/distribution/addon_distribution.py
deleted file mode 100644
index 5e48639dec9..00000000000
--- a/common/openpype_common/distribution/addon_distribution.py
+++ /dev/null
@@ -1,208 +0,0 @@
-import os
-from enum import Enum
-from abc import abstractmethod
-import attr
-import logging
-import requests
-import platform
-import shutil
-
-from .file_handler import RemoteFileHandler
-from .addon_info import AddonInfo
-
-
-class UpdateState(Enum):
- EXISTS = "exists"
- UPDATED = "updated"
- FAILED = "failed"
-
-
-class AddonDownloader:
- log = logging.getLogger(__name__)
-
- def __init__(self):
- self._downloaders = {}
-
- def register_format(self, downloader_type, downloader):
- self._downloaders[downloader_type.value] = downloader
-
- def get_downloader(self, downloader_type):
- downloader = self._downloaders.get(downloader_type)
- if not downloader:
- raise ValueError(f"{downloader_type} not implemented")
- return downloader()
-
- @classmethod
- @abstractmethod
- def download(cls, source, destination):
- """Returns url to downloaded addon zip file.
-
- Args:
- source (dict): {type:"http", "url":"https://} ...}
- destination (str): local folder to unzip
- Returns:
- (str) local path to addon zip file
- """
- pass
-
- @classmethod
- def check_hash(cls, addon_path, addon_hash):
- """Compares 'hash' of downloaded 'addon_url' file.
-
- Args:
- addon_path (str): local path to addon zip file
- addon_hash (str): sha256 hash of zip file
- Raises:
- ValueError if hashes doesn't match
- """
- if not os.path.exists(addon_path):
- raise ValueError(f"{addon_path} doesn't exist.")
- if not RemoteFileHandler.check_integrity(addon_path,
- addon_hash,
- hash_type="sha256"):
- raise ValueError(f"{addon_path} doesn't match expected hash.")
-
- @classmethod
- def unzip(cls, addon_zip_path, destination):
- """Unzips local 'addon_zip_path' to 'destination'.
-
- Args:
- addon_zip_path (str): local path to addon zip file
- destination (str): local folder to unzip
- """
- RemoteFileHandler.unzip(addon_zip_path, destination)
- os.remove(addon_zip_path)
-
- @classmethod
- def remove(cls, addon_url):
- pass
-
-
-class OSAddonDownloader(AddonDownloader):
-
- @classmethod
- def download(cls, source, destination):
- # OS doesnt need to download, unzip directly
- addon_url = source["path"].get(platform.system().lower())
- if not os.path.exists(addon_url):
- raise ValueError("{} is not accessible".format(addon_url))
- return addon_url
-
-
-class HTTPAddonDownloader(AddonDownloader):
- CHUNK_SIZE = 100000
-
- @classmethod
- def download(cls, source, destination):
- source_url = source["url"]
- cls.log.debug(f"Downloading {source_url} to {destination}")
- file_name = os.path.basename(destination)
- _, ext = os.path.splitext(file_name)
- if (ext.replace(".", '') not
- in set(RemoteFileHandler.IMPLEMENTED_ZIP_FORMATS)):
- file_name += ".zip"
- RemoteFileHandler.download_url(source_url,
- destination,
- filename=file_name)
-
- return os.path.join(destination, file_name)
-
-
-def get_addons_info(server_endpoint):
- """Returns list of addon information from Server"""
- # TODO temp
- # addon_info = AddonInfo(
- # **{"name": "openpype_slack",
- # "version": "1.0.0",
- # "addon_url": "c:/projects/openpype_slack_1.0.0.zip",
- # "type": UrlType.FILESYSTEM,
- # "hash": "4be25eb6215e91e5894d3c5475aeb1e379d081d3f5b43b4ee15b0891cf5f5658"}) # noqa
- #
- # http_addon = AddonInfo(
- # **{"name": "openpype_slack",
- # "version": "1.0.0",
- # "addon_url": "https://drive.google.com/file/d/1TcuV8c2OV8CcbPeWi7lxOdqWsEqQNPYy/view?usp=sharing", # noqa
- # "type": UrlType.HTTP,
- # "hash": "4be25eb6215e91e5894d3c5475aeb1e379d081d3f5b43b4ee15b0891cf5f5658"}) # noqa
-
- response = requests.get(server_endpoint)
- if not response.ok:
- raise Exception(response.text)
-
- addons_info = []
- for addon in response.json():
- addons_info.append(AddonInfo(**addon))
- return addons_info
-
-
-def update_addon_state(addon_infos, destination_folder, factory,
- log=None):
- """Loops through all 'addon_infos', compares local version, unzips.
-
- Loops through server provided list of dictionaries with information about
- available addons. Looks if each addon is already present and deployed.
- If isn't, addon zip gets downloaded and unzipped into 'destination_folder'.
- Args:
- addon_infos (list of AddonInfo)
- destination_folder (str): local path
- factory (AddonDownloader): factory to get appropriate downloader per
- addon type
- log (logging.Logger)
- Returns:
- (dict): {"addon_full_name": UpdateState.value
- (eg. "exists"|"updated"|"failed")
- """
- if not log:
- log = logging.getLogger(__name__)
-
- download_states = {}
- for addon in addon_infos:
- full_name = "{}_{}".format(addon.name, addon.version)
- addon_dest = os.path.join(destination_folder, full_name)
-
- if os.path.isdir(addon_dest):
- log.debug(f"Addon version folder {addon_dest} already exists.")
- download_states[full_name] = UpdateState.EXISTS.value
- continue
-
- for source in addon.sources:
- download_states[full_name] = UpdateState.FAILED.value
- try:
- downloader = factory.get_downloader(source.type)
- zip_file_path = downloader.download(attr.asdict(source),
- addon_dest)
- downloader.check_hash(zip_file_path, addon.hash)
- downloader.unzip(zip_file_path, addon_dest)
- download_states[full_name] = UpdateState.UPDATED.value
- break
- except Exception:
- log.warning(f"Error happened during updating {addon.name}",
- exc_info=True)
- if os.path.isdir(addon_dest):
- log.debug(f"Cleaning {addon_dest}")
- shutil.rmtree(addon_dest)
-
- return download_states
-
-
-def check_addons(server_endpoint, addon_folder, downloaders):
- """Main entry point to compare existing addons with those on server.
-
- Args:
- server_endpoint (str): url to v4 server endpoint
- addon_folder (str): local dir path for addons
- downloaders (AddonDownloader): factory of downloaders
-
- Raises:
- (RuntimeError) if any addon failed update
- """
- addons_info = get_addons_info(server_endpoint)
- result = update_addon_state(addons_info,
- addon_folder,
- downloaders)
- if UpdateState.FAILED.value in result.values():
- raise RuntimeError(f"Unable to update some addons {result}")
-
-
-def cli(*args):
- raise NotImplementedError
diff --git a/common/openpype_common/distribution/addon_info.py b/common/openpype_common/distribution/addon_info.py
deleted file mode 100644
index 00ece11f3b4..00000000000
--- a/common/openpype_common/distribution/addon_info.py
+++ /dev/null
@@ -1,80 +0,0 @@
-import attr
-from enum import Enum
-
-
-class UrlType(Enum):
- HTTP = "http"
- GIT = "git"
- FILESYSTEM = "filesystem"
-
-
-@attr.s
-class MultiPlatformPath(object):
- windows = attr.ib(default=None)
- linux = attr.ib(default=None)
- darwin = attr.ib(default=None)
-
-
-@attr.s
-class AddonSource(object):
- type = attr.ib()
-
-
-@attr.s
-class LocalAddonSource(AddonSource):
- path = attr.ib(default=attr.Factory(MultiPlatformPath))
-
-
-@attr.s
-class WebAddonSource(AddonSource):
- url = attr.ib(default=None)
-
-
-@attr.s
-class VersionData(object):
- version_data = attr.ib(default=None)
-
-
-@attr.s
-class AddonInfo(object):
- """Object matching json payload from Server"""
- name = attr.ib()
- version = attr.ib()
- title = attr.ib(default=None)
- sources = attr.ib(default=attr.Factory(dict))
- hash = attr.ib(default=None)
- description = attr.ib(default=None)
- license = attr.ib(default=None)
- authors = attr.ib(default=None)
-
- @classmethod
- def from_dict(cls, data):
- sources = []
-
- production_version = data.get("productionVersion")
- if not production_version:
- return
-
- # server payload contains info about all versions
- # active addon must have 'productionVersion' and matching version info
- version_data = data.get("versions", {})[production_version]
-
- for source in version_data.get("clientSourceInfo", []):
- if source.get("type") == UrlType.FILESYSTEM.value:
- source_addon = LocalAddonSource(type=source["type"],
- path=source["path"])
- if source.get("type") == UrlType.HTTP.value:
- source_addon = WebAddonSource(type=source["type"],
- url=source["url"])
-
- sources.append(source_addon)
-
- return cls(name=data.get("name"),
- version=production_version,
- sources=sources,
- hash=data.get("hash"),
- description=data.get("description"),
- title=data.get("title"),
- license=data.get("license"),
- authors=data.get("authors"))
-
diff --git a/common/openpype_common/distribution/file_handler.py b/common/openpype_common/distribution/file_handler.py
deleted file mode 100644
index e649f143e9d..00000000000
--- a/common/openpype_common/distribution/file_handler.py
+++ /dev/null
@@ -1,288 +0,0 @@
-import os
-import re
-import urllib
-from urllib.parse import urlparse
-import urllib.request
-import urllib.error
-import itertools
-import hashlib
-import tarfile
-import zipfile
-
-
-USER_AGENT = "openpype"
-
-
-class RemoteFileHandler:
- """Download file from url, might be GDrive shareable link"""
-
- IMPLEMENTED_ZIP_FORMATS = ['zip', 'tar', 'tgz',
- 'tar.gz', 'tar.xz', 'tar.bz2']
-
- @staticmethod
- def calculate_md5(fpath, chunk_size=10000):
- md5 = hashlib.md5()
- with open(fpath, 'rb') as f:
- for chunk in iter(lambda: f.read(chunk_size), b''):
- md5.update(chunk)
- return md5.hexdigest()
-
- @staticmethod
- def check_md5(fpath, md5, **kwargs):
- return md5 == RemoteFileHandler.calculate_md5(fpath, **kwargs)
-
- @staticmethod
- def calculate_sha256(fpath):
- """Calculate sha256 for content of the file.
-
- Args:
- fpath (str): Path to file.
-
- Returns:
- str: hex encoded sha256
-
- """
- h = hashlib.sha256()
- b = bytearray(128 * 1024)
- mv = memoryview(b)
- with open(fpath, 'rb', buffering=0) as f:
- for n in iter(lambda: f.readinto(mv), 0):
- h.update(mv[:n])
- return h.hexdigest()
-
- @staticmethod
- def check_sha256(fpath, sha256, **kwargs):
- return sha256 == RemoteFileHandler.calculate_sha256(fpath, **kwargs)
-
- @staticmethod
- def check_integrity(fpath, hash_value=None, hash_type=None):
- if not os.path.isfile(fpath):
- return False
- if hash_value is None:
- return True
- if not hash_type:
- raise ValueError("Provide hash type, md5 or sha256")
- if hash_type == 'md5':
- return RemoteFileHandler.check_md5(fpath, hash_value)
- if hash_type == "sha256":
- return RemoteFileHandler.check_sha256(fpath, hash_value)
-
- @staticmethod
- def download_url(
- url, root, filename=None,
- sha256=None, max_redirect_hops=3
- ):
- """Download a file from a url and place it in root.
- Args:
- url (str): URL to download file from
- root (str): Directory to place downloaded file in
- filename (str, optional): Name to save the file under.
- If None, use the basename of the URL
- sha256 (str, optional): sha256 checksum of the download.
- If None, do not check
- max_redirect_hops (int, optional): Maximum number of redirect
- hops allowed
- """
- root = os.path.expanduser(root)
- if not filename:
- filename = os.path.basename(url)
- fpath = os.path.join(root, filename)
-
- os.makedirs(root, exist_ok=True)
-
- # check if file is already present locally
- if RemoteFileHandler.check_integrity(fpath,
- sha256, hash_type="sha256"):
- print('Using downloaded and verified file: ' + fpath)
- return
-
- # expand redirect chain if needed
- url = RemoteFileHandler._get_redirect_url(url,
- max_hops=max_redirect_hops)
-
- # check if file is located on Google Drive
- file_id = RemoteFileHandler._get_google_drive_file_id(url)
- if file_id is not None:
- return RemoteFileHandler.download_file_from_google_drive(
- file_id, root, filename, sha256)
-
- # download the file
- try:
- print('Downloading ' + url + ' to ' + fpath)
- RemoteFileHandler._urlretrieve(url, fpath)
- except (urllib.error.URLError, IOError) as e:
- if url[:5] == 'https':
- url = url.replace('https:', 'http:')
- print('Failed download. Trying https -> http instead.'
- ' Downloading ' + url + ' to ' + fpath)
- RemoteFileHandler._urlretrieve(url, fpath)
- else:
- raise e
-
- # check integrity of downloaded file
- if not RemoteFileHandler.check_integrity(fpath,
- sha256, hash_type="sha256"):
- raise RuntimeError("File not found or corrupted.")
-
- @staticmethod
- def download_file_from_google_drive(file_id, root,
- filename=None,
- sha256=None):
- """Download a Google Drive file from and place it in root.
- Args:
- file_id (str): id of file to be downloaded
- root (str): Directory to place downloaded file in
- filename (str, optional): Name to save the file under.
- If None, use the id of the file.
- sha256 (str, optional): sha256 checksum of the download.
- If None, do not check
- """
- # Based on https://stackoverflow.com/questions/38511444/python-download-files-from-google-drive-using-url # noqa
- import requests
- url = "https://docs.google.com/uc?export=download"
-
- root = os.path.expanduser(root)
- if not filename:
- filename = file_id
- fpath = os.path.join(root, filename)
-
- os.makedirs(root, exist_ok=True)
-
- if os.path.isfile(fpath) and RemoteFileHandler.check_integrity(
- fpath, sha256, hash_type="sha256"):
- print('Using downloaded and verified file: ' + fpath)
- else:
- session = requests.Session()
-
- response = session.get(url, params={'id': file_id}, stream=True)
- token = RemoteFileHandler._get_confirm_token(response)
-
- if token:
- params = {'id': file_id, 'confirm': token}
- response = session.get(url, params=params, stream=True)
-
- response_content_generator = response.iter_content(32768)
- first_chunk = None
- while not first_chunk: # filter out keep-alive new chunks
- first_chunk = next(response_content_generator)
-
- if RemoteFileHandler._quota_exceeded(first_chunk):
- msg = (
- f"The daily quota of the file {filename} is exceeded and "
- f"it can't be downloaded. This is a limitation of "
- f"Google Drive and can only be overcome by trying "
- f"again later."
- )
- raise RuntimeError(msg)
-
- RemoteFileHandler._save_response_content(
- itertools.chain((first_chunk, ),
- response_content_generator), fpath)
- response.close()
-
- @staticmethod
- def unzip(path, destination_path=None):
- if not destination_path:
- destination_path = os.path.dirname(path)
-
- _, archive_type = os.path.splitext(path)
- archive_type = archive_type.lstrip('.')
-
- if archive_type in ['zip']:
- print("Unzipping {}->{}".format(path, destination_path))
- zip_file = zipfile.ZipFile(path)
- zip_file.extractall(destination_path)
- zip_file.close()
-
- elif archive_type in [
- 'tar', 'tgz', 'tar.gz', 'tar.xz', 'tar.bz2'
- ]:
- print("Unzipping {}->{}".format(path, destination_path))
- if archive_type == 'tar':
- tar_type = 'r:'
- elif archive_type.endswith('xz'):
- tar_type = 'r:xz'
- elif archive_type.endswith('gz'):
- tar_type = 'r:gz'
- elif archive_type.endswith('bz2'):
- tar_type = 'r:bz2'
- else:
- tar_type = 'r:*'
- try:
- tar_file = tarfile.open(path, tar_type)
- except tarfile.ReadError:
- raise SystemExit("corrupted archive")
- tar_file.extractall(destination_path)
- tar_file.close()
-
- @staticmethod
- def _urlretrieve(url, filename, chunk_size):
- with open(filename, "wb") as fh:
- with urllib.request.urlopen(
- urllib.request.Request(url,
- headers={"User-Agent": USER_AGENT})) \
- as response:
- for chunk in iter(lambda: response.read(chunk_size), ""):
- if not chunk:
- break
- fh.write(chunk)
-
- @staticmethod
- def _get_redirect_url(url, max_hops):
- initial_url = url
- headers = {"Method": "HEAD", "User-Agent": USER_AGENT}
-
- for _ in range(max_hops + 1):
- with urllib.request.urlopen(
- urllib.request.Request(url, headers=headers)) as response:
- if response.url == url or response.url is None:
- return url
-
- url = response.url
- else:
- raise RecursionError(
- f"Request to {initial_url} exceeded {max_hops} redirects. "
- f"The last redirect points to {url}."
- )
-
- @staticmethod
- def _get_confirm_token(response):
- for key, value in response.cookies.items():
- if key.startswith('download_warning'):
- return value
-
- # handle antivirus warning for big zips
- found = re.search("(confirm=)([^&.+])", response.text)
- if found:
- return found.groups()[1]
-
- return None
-
- @staticmethod
- def _save_response_content(
- response_gen, destination,
- ):
- with open(destination, "wb") as f:
- for chunk in response_gen:
- if chunk: # filter out keep-alive new chunks
- f.write(chunk)
-
- @staticmethod
- def _quota_exceeded(first_chunk):
- try:
- return "Google Drive - Quota exceeded" in first_chunk.decode()
- except UnicodeDecodeError:
- return False
-
- @staticmethod
- def _get_google_drive_file_id(url):
- parts = urlparse(url)
-
- if re.match(r"(drive|docs)[.]google[.]com", parts.netloc) is None:
- return None
-
- match = re.match(r"/file/d/(?P[^/]*)", parts.path)
- if match is None:
- return None
-
- return match.group("id")
diff --git a/common/openpype_common/distribution/tests/test_addon_distributtion.py b/common/openpype_common/distribution/tests/test_addon_distributtion.py
deleted file mode 100644
index 765ea0596a1..00000000000
--- a/common/openpype_common/distribution/tests/test_addon_distributtion.py
+++ /dev/null
@@ -1,167 +0,0 @@
-import pytest
-import attr
-import tempfile
-
-from common.openpype_common.distribution.addon_distribution import (
- AddonDownloader,
- OSAddonDownloader,
- HTTPAddonDownloader,
- AddonInfo,
- update_addon_state,
- UpdateState
-)
-from common.openpype_common.distribution.addon_info import UrlType
-
-
-@pytest.fixture
-def addon_downloader():
- addon_downloader = AddonDownloader()
- addon_downloader.register_format(UrlType.FILESYSTEM, OSAddonDownloader)
- addon_downloader.register_format(UrlType.HTTP, HTTPAddonDownloader)
-
- yield addon_downloader
-
-
-@pytest.fixture
-def http_downloader(addon_downloader):
- yield addon_downloader.get_downloader(UrlType.HTTP.value)
-
-
-@pytest.fixture
-def temp_folder():
- yield tempfile.mkdtemp()
-
-
-@pytest.fixture
-def sample_addon_info():
- addon_info = {
- "versions": {
- "1.0.0": {
- "clientPyproject": {
- "tool": {
- "poetry": {
- "dependencies": {
- "nxtools": "^1.6",
- "orjson": "^3.6.7",
- "typer": "^0.4.1",
- "email-validator": "^1.1.3",
- "python": "^3.10",
- "fastapi": "^0.73.0"
- }
- }
- }
- },
- "hasSettings": True,
- "clientSourceInfo": [
- {
- "type": "http",
- "url": "https://drive.google.com/file/d/1TcuV8c2OV8CcbPeWi7lxOdqWsEqQNPYy/view?usp=sharing" # noqa
- },
- {
- "type": "filesystem",
- "path": {
- "windows": ["P:/sources/some_file.zip",
- "W:/sources/some_file.zip"], # noqa
- "linux": ["/mnt/srv/sources/some_file.zip"],
- "darwin": ["/Volumes/srv/sources/some_file.zip"]
- }
- }
- ],
- "frontendScopes": {
- "project": {
- "sidebar": "hierarchy"
- }
- }
- }
- },
- "description": "",
- "title": "Slack addon",
- "name": "openpype_slack",
- "productionVersion": "1.0.0",
- "hash": "4be25eb6215e91e5894d3c5475aeb1e379d081d3f5b43b4ee15b0891cf5f5658" # noqa
- }
- yield addon_info
-
-
-def test_register(printer):
- addon_downloader = AddonDownloader()
-
- assert len(addon_downloader._downloaders) == 0, "Contains registered"
-
- addon_downloader.register_format(UrlType.FILESYSTEM, OSAddonDownloader)
- assert len(addon_downloader._downloaders) == 1, "Should contain one"
-
-
-def test_get_downloader(printer, addon_downloader):
- assert addon_downloader.get_downloader(UrlType.FILESYSTEM.value), "Should find" # noqa
-
- with pytest.raises(ValueError):
- addon_downloader.get_downloader("unknown"), "Shouldn't find"
-
-
-def test_addon_info(printer, sample_addon_info):
- """Tests parsing of expected payload from v4 server into AadonInfo."""
- valid_minimum = {
- "name": "openpype_slack",
- "productionVersion": "1.0.0",
- "versions": {
- "1.0.0": {
- "clientSourceInfo": [
- {
- "type": "filesystem",
- "path": {
- "windows": [
- "P:/sources/some_file.zip",
- "W:/sources/some_file.zip"],
- "linux": [
- "/mnt/srv/sources/some_file.zip"],
- "darwin": [
- "/Volumes/srv/sources/some_file.zip"] # noqa
- }
- }
- ]
- }
- }
- }
-
- assert AddonInfo.from_dict(valid_minimum), "Missing required fields"
-
- valid_minimum["versions"].pop("1.0.0")
- with pytest.raises(KeyError):
- assert not AddonInfo.from_dict(valid_minimum), "Must fail without version data" # noqa
-
- valid_minimum.pop("productionVersion")
- assert not AddonInfo.from_dict(
- valid_minimum), "none if not productionVersion" # noqa
-
- addon = AddonInfo.from_dict(sample_addon_info)
- assert addon, "Should be created"
- assert addon.name == "openpype_slack", "Incorrect name"
- assert addon.version == "1.0.0", "Incorrect version"
-
- with pytest.raises(TypeError):
- assert addon["name"], "Dict approach not implemented"
-
- addon_as_dict = attr.asdict(addon)
- assert addon_as_dict["name"], "Dict approach should work"
-
-
-def test_update_addon_state(printer, sample_addon_info,
- temp_folder, addon_downloader):
- """Tests possible cases of addon update."""
- addon_info = AddonInfo.from_dict(sample_addon_info)
- orig_hash = addon_info.hash
-
- addon_info.hash = "brokenhash"
- result = update_addon_state([addon_info], temp_folder, addon_downloader)
- assert result["openpype_slack_1.0.0"] == UpdateState.FAILED.value, \
- "Update should failed because of wrong hash"
-
- addon_info.hash = orig_hash
- result = update_addon_state([addon_info], temp_folder, addon_downloader)
- assert result["openpype_slack_1.0.0"] == UpdateState.UPDATED.value, \
- "Addon should have been updated"
-
- result = update_addon_state([addon_info], temp_folder, addon_downloader)
- assert result["openpype_slack_1.0.0"] == UpdateState.EXISTS.value, \
- "Addon should already exist"
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000000..102da990aa9
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,74 @@
+API Documentation
+=================
+
+This documents the way how to build and modify API documentation using Sphinx and AutoAPI. Ground for documentation
+should be directly in sources - in docstrings and markdowns. Sphinx and AutoAPI will crawl over them and generate
+RST files that are in turn used to generate HTML documentation. For docstrings we prefer "Napoleon" or "Google" style
+docstrings, but RST is also acceptable mainly in cases where you need to use Sphinx directives.
+
+Using only docstrings is not really viable as some documentation should be done on higher level - like overview of
+some modules/functionality and so on. This should be done directly in RST files and committed to repository.
+
+Configuration
+-------------
+Configuration is done in `/docs/source/conf.py`. The most important settings are:
+
+- `autodoc_mock_imports`: add modules that can't be actually imported by Sphinx in running environment, like `nuke`, `maya`, etc.
+- `autoapi_ignore`: add directories that shouldn't be processed by **AutoAPI**, like vendor dirs, etc.
+- `html_theme_options`: you can use these options to influence how the html theme of the generated files will look.
+- `myst_gfm_only`: are Myst parser option for Markdown setting what flavour of Markdown should be used.
+
+How to build it
+---------------
+
+You can run:
+
+```sh
+cd .\docs
+make.bat html
+```
+
+on linux/macOS:
+
+```sh
+cd ./docs
+make html
+```
+
+This will go over our code and generate **.rst** files in `/docs/source/autoapi` and from those it will generate
+full html documentation in `/docs/build/html`.
+
+During the build you may see tons of red errors that are pointing to our issues:
+
+1) **Wrong imports** -
+Invalid import are usually wrong relative imports (too deep) or circular imports.
+2) **Invalid docstrings** -
+Docstrings to be processed into documentation needs to follow some syntax - this can be checked by running
+`pydocstyle` that is already included with OpenPype
+3) **Invalid markdown/rst files** -
+Markdown/RST files can be included inside RST files using `.. include::` directive. But they have to be properly
+formatted.
+
+Editing RST templates
+---------------------
+Everything starts with `/docs/source/index.rst` - this file should be properly edited, Right now it just
+includes `readme.rst` that in turn include and parse main `README.md`. This is entrypoint to API documentation.
+All templates generated by AutoAPI are in `/docs/source/autoapi`. They should be eventually committed to repository
+and edited too.
+
+Steps for enhancing API documentation
+-------------------------------------
+
+1) Run `/docs/make.bat html`
+2) Read the red errors/warnings - fix it in the code
+3) Run `/docs/make.bat html` - again until there are no red lines
+4) Edit RST files and add some meaningful content there
+
+Resources
+=========
+
+- [ReStructuredText on Wikipedia](https://en.wikipedia.org/wiki/ReStructuredText)
+- [RST Quick Reference](https://docutils.sourceforge.io/docs/user/rst/quickref.html)
+- [Sphinx AutoAPI Documentation](https://sphinx-autoapi.readthedocs.io/en/latest/)
+- [Example of Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
+- [Sphinx Directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
diff --git a/docs/make.bat b/docs/make.bat
index 4d9eb83d9f9..1d261df2779 100644
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -5,7 +5,7 @@ pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
+ set SPHINXBUILD=..\.poetry\bin\poetry run sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
diff --git a/docs/source/_static/AYON_tight_G.svg b/docs/source/_static/AYON_tight_G.svg
new file mode 100644
index 00000000000..2c5b73deea2
--- /dev/null
+++ b/docs/source/_static/AYON_tight_G.svg
@@ -0,0 +1,38 @@
+
+
+
diff --git a/common/openpype_common/distribution/__init__.py b/docs/source/_static/README.md
similarity index 100%
rename from common/openpype_common/distribution/__init__.py
rename to docs/source/_static/README.md
diff --git a/docs/source/_templates/autoapi/index.rst b/docs/source/_templates/autoapi/index.rst
new file mode 100644
index 00000000000..95d0ad89112
--- /dev/null
+++ b/docs/source/_templates/autoapi/index.rst
@@ -0,0 +1,15 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation [#f1]_.
+
+.. toctree::
+ :titlesonly:
+
+ {% for page in pages %}
+ {% if page.top_level_object and page.display %}
+ {{ page.include_path }}
+ {% endif %}
+ {% endfor %}
+
+.. [#f1] Created with `sphinx-autoapi `_
diff --git a/docs/source/_templates/autoapi/python/attribute.rst b/docs/source/_templates/autoapi/python/attribute.rst
new file mode 100644
index 00000000000..ebaba555adc
--- /dev/null
+++ b/docs/source/_templates/autoapi/python/attribute.rst
@@ -0,0 +1 @@
+{% extends "python/data.rst" %}
diff --git a/docs/source/_templates/autoapi/python/class.rst b/docs/source/_templates/autoapi/python/class.rst
new file mode 100644
index 00000000000..df5edffb62e
--- /dev/null
+++ b/docs/source/_templates/autoapi/python/class.rst
@@ -0,0 +1,58 @@
+{% if obj.display %}
+.. py:{{ obj.type }}:: {{ obj.short_name }}{% if obj.args %}({{ obj.args }}){% endif %}
+{% for (args, return_annotation) in obj.overloads %}
+ {{ " " * (obj.type | length) }} {{ obj.short_name }}{% if args %}({{ args }}){% endif %}
+{% endfor %}
+
+
+ {% if obj.bases %}
+ {% if "show-inheritance" in autoapi_options %}
+ Bases: {% for base in obj.bases %}{{ base|link_objs }}{% if not loop.last %}, {% endif %}{% endfor %}
+ {% endif %}
+
+
+ {% if "show-inheritance-diagram" in autoapi_options and obj.bases != ["object"] %}
+ .. autoapi-inheritance-diagram:: {{ obj.obj["full_name"] }}
+ :parts: 1
+ {% if "private-members" in autoapi_options %}
+ :private-bases:
+ {% endif %}
+
+ {% endif %}
+ {% endif %}
+ {% if obj.docstring %}
+ {{ obj.docstring|indent(3) }}
+ {% endif %}
+ {% if "inherited-members" in autoapi_options %}
+ {% set visible_classes = obj.classes|selectattr("display")|list %}
+ {% else %}
+ {% set visible_classes = obj.classes|rejectattr("inherited")|selectattr("display")|list %}
+ {% endif %}
+ {% for klass in visible_classes %}
+ {{ klass.render()|indent(3) }}
+ {% endfor %}
+ {% if "inherited-members" in autoapi_options %}
+ {% set visible_properties = obj.properties|selectattr("display")|list %}
+ {% else %}
+ {% set visible_properties = obj.properties|rejectattr("inherited")|selectattr("display")|list %}
+ {% endif %}
+ {% for property in visible_properties %}
+ {{ property.render()|indent(3) }}
+ {% endfor %}
+ {% if "inherited-members" in autoapi_options %}
+ {% set visible_attributes = obj.attributes|selectattr("display")|list %}
+ {% else %}
+ {% set visible_attributes = obj.attributes|rejectattr("inherited")|selectattr("display")|list %}
+ {% endif %}
+ {% for attribute in visible_attributes %}
+ {{ attribute.render()|indent(3) }}
+ {% endfor %}
+ {% if "inherited-members" in autoapi_options %}
+ {% set visible_methods = obj.methods|selectattr("display")|list %}
+ {% else %}
+ {% set visible_methods = obj.methods|rejectattr("inherited")|selectattr("display")|list %}
+ {% endif %}
+ {% for method in visible_methods %}
+ {{ method.render()|indent(3) }}
+ {% endfor %}
+{% endif %}
diff --git a/docs/source/_templates/autoapi/python/data.rst b/docs/source/_templates/autoapi/python/data.rst
new file mode 100644
index 00000000000..3d12b2d0c7c
--- /dev/null
+++ b/docs/source/_templates/autoapi/python/data.rst
@@ -0,0 +1,37 @@
+{% if obj.display %}
+.. py:{{ obj.type }}:: {{ obj.name }}
+ {%- if obj.annotation is not none %}
+
+ :type: {%- if obj.annotation %} {{ obj.annotation }}{%- endif %}
+
+ {%- endif %}
+
+ {%- if obj.value is not none %}
+
+ :value: {% if obj.value is string and obj.value.splitlines()|count > 1 -%}
+ Multiline-String
+
+ .. raw:: html
+
+ Show Value
+
+ .. code-block:: python
+
+ """{{ obj.value|indent(width=8,blank=true) }}"""
+
+ .. raw:: html
+
+