Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Automated] Release

Browse source
This commit is contained in:
Ynbot 2023-07-13 12:47:41 +00:00
parent cc14e27ede
commit f725992818
3 changed files with 850 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

848
CHANGELOG.md
View file

@ -1,6 +1,854 @@
# Changelog
## [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**
<details>
<summary>General: Reduce usage of legacy io <a href="https://github.com/ynput/OpenPype/pull/4723">#4723</a></summary>
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.
___
</details>
<details>
<summary>Documentation: API docs reborn - yet again <a href="https://github.com/ynput/OpenPype/pull/4419">#4419</a></summary>
## 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
___
</details>
<details>
<summary>Global: custom location for OP local versions <a href="https://github.com/ynput/OpenPype/pull/4673">#4673</a></summary>
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)
___
</details>
<details>
<summary>AYON: Update settings conversion <a href="https://github.com/ynput/OpenPype/pull/4837">#4837</a></summary>
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.
___
</details>
<details>
<summary>AYON: Implement integrate links publish plugin <a href="https://github.com/ynput/OpenPype/pull/4842">#4842</a></summary>
Implemented entity links get/create functions. Added new integrator which replaces v3 integrator for links.
___
</details>
<details>
<summary>General: Version attributes integration <a href="https://github.com/ynput/OpenPype/pull/4991">#4991</a></summary>
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.
___
</details>
<details>
<summary>AYON: Staging versions can be used <a href="https://github.com/ynput/OpenPype/pull/4992">#4992</a></summary>
Added ability to use staging versions in AYON mode.
___
</details>
<details>
<summary>AYON: Preparation for products <a href="https://github.com/ynput/OpenPype/pull/5038">#5038</a></summary>
Prepare ayon settings conversion script for `product` settings conversion.
___
</details>
<details>
<summary>Loader: Hide inactive versions in UI <a href="https://github.com/ynput/OpenPype/pull/5101">#5101</a></summary>
Added support for `active` argument to hide versions with active set to False in Loader UI when in AYON mode.
___
</details>
<details>
<summary>General: CLI addon command <a href="https://github.com/ynput/OpenPype/pull/5109">#5109</a></summary>
Added `addon` alias for `module` in OpenPype cli commands.
___
</details>
<details>
<summary>AYON: OpenPype as server addon <a href="https://github.com/ynput/OpenPype/pull/5199">#5199</a></summary>
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).
___
</details>
<details>
<summary>General: Runtime dependencies <a href="https://github.com/ynput/OpenPype/pull/5206">#5206</a></summary>
Defined runtime dependencies in pyproject toml. Moved python ocio and otio modules there.
___
</details>
<details>
<summary>AYON: Bundle distribution <a href="https://github.com/ynput/OpenPype/pull/5209">#5209</a></summary>
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.
___
</details>
<details>
<summary>Feature/blender handle q application <a href="https://github.com/ynput/OpenPype/pull/5264">#5264</a></summary>
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.
___
</details>
### **🚀 Enhancements**
<details>
<summary>General: Connect to AYON server (base) <a href="https://github.com/ynput/OpenPype/pull/3924">#3924</a></summary>
<strong>Initial implementation of being able use AYON server in current OpenPype client. Added ability to connect to AYON server and use base queries.
</strong>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.
___
</details>
<details>
<summary>Enhancement kitsu note with exceptions <a href="https://github.com/ynput/OpenPype/pull/4537">#4537</a></summary>
Adding a setting to choose some exceptions to IntegrateKitsuNote task status changes.
___
</details>
<details>
<summary>General: Environment variable for default OCIO configs <a href="https://github.com/ynput/OpenPype/pull/4670">#4670</a></summary>
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.
___
</details>
<details>
<summary>AYON: Editorial hierarchy creation <a href="https://github.com/ynput/OpenPype/pull/4699">#4699</a></summary>
Implemented extract hierarchy to AYON plugin which created entities in AYON using ayon api.
___
</details>
<details>
<summary>AYON: Vendorize ayon api <a href="https://github.com/ynput/OpenPype/pull/4753">#4753</a></summary>
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.
___
</details>
<details>
<summary>General: Update PySide 6 for MacOs <a href="https://github.com/ynput/OpenPype/pull/4764">#4764</a></summary>
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.
___
</details>
<details>
<summary>General: Removed unused cli commands <a href="https://github.com/ynput/OpenPype/pull/4902">#4902</a></summary>
Removed `texturecopy` and `launch` cli commands from cli commands.
___
</details>
<details>
<summary>AYON: Linux & MacOS launch script <a href="https://github.com/ynput/OpenPype/pull/4970">#4970</a></summary>
Added shell script to launch tray in AYON mode.
___
</details>
<details>
<summary>General: Qt scale enhancement <a href="https://github.com/ynput/OpenPype/pull/5059">#5059</a></summary>
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).
___
</details>
<details>
<summary>CI: WPS linting instead of Hound (rebase) 2 <a href="https://github.com/ynput/OpenPype/pull/5115">#5115</a></summary>
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.
___
</details>
<details>
<summary>Max: OP parameters only displays what is attached to the container <a href="https://github.com/ynput/OpenPype/pull/5229">#5229</a></summary>
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.
___
</details>
<details>
<summary>Testing: improving logging during testing <a href="https://github.com/ynput/OpenPype/pull/5271">#5271</a></summary>
Unit testing logging was crashing on more then one nested layers of inherited loggers.
___
</details>
<details>
<summary>Nuke: removing deprecated settings in baking <a href="https://github.com/ynput/OpenPype/pull/5275">#5275</a></summary>
Removing deprecated settings for baking with reformat. This option was only for single reformat node and it had been substituted with multiple reposition nodes.
___
</details>
### **🐛 Bug fixes**
<details>
<summary>AYON: General fixes and updates <a href="https://github.com/ynput/OpenPype/pull/4975">#4975</a></summary>
Few smaller fixes related to AYON connection. Some of fixes were taken from this PR.
___
</details>
<details>
<summary>Start script: Change returncode on validate or list versions <a href="https://github.com/ynput/OpenPype/pull/4515">#4515</a></summary>
<strong>Change exit code from `1` to `0` when versions are printed or when version is validated.
</strong>Return code `1` is indicating error but there didn't happen any error.
___
</details>
<details>
<summary>AYON: Change login UI works <a href="https://github.com/ynput/OpenPype/pull/4754">#4754</a></summary>
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.
___
</details>
<details>
<summary>AYON: General issues <a href="https://github.com/ynput/OpenPype/pull/4763">#4763</a></summary>
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.
___
</details>
<details>
<summary>AYON: Small fixes <a href="https://github.com/ynput/OpenPype/pull/4841">#4841</a></summary>
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`.
___
</details>
<details>
<summary>Bugfix - Update gazu to 0.9.3 <a href="https://github.com/ynput/OpenPype/pull/4845">#4845</a></summary>
This updates Gazu to 0.9.3 to make sure Gazu works with Kitsu and Zou 0.16.x+
___
</details>
<details>
<summary>Igniter: fix error reports in silent mode <a href="https://github.com/ynput/OpenPype/pull/4909">#4909</a></summary>
Some errors in silent mode commands in Igniter were suppressed and not visible for example in Deadline log.
___
</details>
<details>
<summary>General: Remove ayon api from poetry lock <a href="https://github.com/ynput/OpenPype/pull/4964">#4964</a></summary>
Remove AYON python api from pyproject.toml and poetry.lock again.
___
</details>
<details>
<summary>Ftrack: Fix AYON settings conversion <a href="https://github.com/ynput/OpenPype/pull/4967">#4967</a></summary>
Fix conversion of ftrack settings in AYON mode.
___
</details>
<details>
<summary>AYON: ISO date format conversion issues <a href="https://github.com/ynput/OpenPype/pull/4981">#4981</a></summary>
Function `datetime.fromisoformat` was replaced with `arrow.get` to be used instead.
___
</details>
<details>
<summary>AYON: Missing files on representations <a href="https://github.com/ynput/OpenPype/pull/4989">#4989</a></summary>
Fix integration of files into representation in server database.
___
</details>
<details>
<summary>General: Fix Python 2 vendor for arrow <a href="https://github.com/ynput/OpenPype/pull/4993">#4993</a></summary>
Moved remaining dependencies for arrow from ftrack to python 2 vendor.
___
</details>
<details>
<summary>General: Fix new load plugins for next minor relase <a href="https://github.com/ynput/OpenPype/pull/5000">#5000</a></summary>
Fix access to `fname` attribute which is not available on load plugin anymore.
___
</details>
<details>
<summary>General: Fix mongo secure connection <a href="https://github.com/ynput/OpenPype/pull/5031">#5031</a></summary>
Fix `ssl` and `tls` keys checks in mongo uri query string.
___
</details>
<details>
<summary>AYON: Fix site sync settings <a href="https://github.com/ynput/OpenPype/pull/5069">#5069</a></summary>
Fixed settings for AYON variant of sync server.
___
</details>
<details>
<summary>General: Replace deprecated keyword argument in PyMongo <a href="https://github.com/ynput/OpenPype/pull/5080">#5080</a></summary>
Use argument `tlsCAFile` instead of `ssl_ca_certs` to avoid deprecation warnings.
___
</details>
<details>
<summary>Igniter: QApplication is created <a href="https://github.com/ynput/OpenPype/pull/5081">#5081</a></summary>
Function `_get_qt_app` actually creates new `QApplication` if was not created yet.
___
</details>
<details>
<summary>General: Lower unidecode version <a href="https://github.com/ynput/OpenPype/pull/5090">#5090</a></summary>
Use older version of Unidecode module to support Python 2.
___
</details>
<details>
<summary>General: Lower cryptography to 39.0.0 <a href="https://github.com/ynput/OpenPype/pull/5099">#5099</a></summary>
Lower cryptography to 39.0.0 to avoid breaking of DCCs like Maya and Nuke.
___
</details>
<details>
<summary>AYON: Global environments key fix <a href="https://github.com/ynput/OpenPype/pull/5118">#5118</a></summary>
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
___
</details>
<details>
<summary>Add collector to tray publisher for getting frame range data <a href="https://github.com/ynput/OpenPype/pull/5152">#5152</a></summary>
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
___
</details>
<details>
<summary>Unreal: get current project settings not using unreal project name <a href="https://github.com/ynput/OpenPype/pull/5170">#5170</a></summary>
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.
___
</details>
<details>
<summary>Substance Painter: Fix Collect Texture Set Images unable to copy.deepcopy due to QMenu <a href="https://github.com/ynput/OpenPype/pull/5238">#5238</a></summary>
Fix `copy.deepcopy` of `instance.data`.
___
</details>
<details>
<summary>Ayon: server returns different key <a href="https://github.com/ynput/OpenPype/pull/5251">#5251</a></summary>
Package returned from server has `filename` instead of `name`.
___
</details>
<details>
<summary>Substance Painter: Fix default color management settings <a href="https://github.com/ynput/OpenPype/pull/5259">#5259</a></summary>
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_
___
</details>
<details>
<summary>Nuke: fixing container data if windows path in value <a href="https://github.com/ynput/OpenPype/pull/5267">#5267</a></summary>
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.
___
</details>
<details>
<summary>Houdini: fix typo error in collect arnold rop <a href="https://github.com/ynput/OpenPype/pull/5281">#5281</a></summary>
Fixing a typo error in `collect_arnold_rop.py`Reference: #5280
___
</details>
<details>
<summary>Slack - enhanced logging and protection against failure <a href="https://github.com/ynput/OpenPype/pull/5287">#5287</a></summary>
Covered issues found in production on customer site. SlackAPI exception doesn't need to have 'error', covered uncaught exception.
___
</details>
<details>
<summary>Maya: Removed unnecessary import of pyblish.cli <a href="https://github.com/ynput/OpenPype/pull/5292">#5292</a></summary>
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.
___
</details>
### **🔀 Refactored code**
<details>
<summary>Loader: Remove `context` argument from Loader.__init__() <a href="https://github.com/ynput/OpenPype/pull/4602">#4602</a></summary>
Remove the previously required `context` argument.
___
</details>
<details>
<summary>Global: Remove legacy integrator <a href="https://github.com/ynput/OpenPype/pull/4786">#4786</a></summary>
Remove the legacy integrator.
___
</details>
### **📃 Documentation**
<details>
<summary>Next Minor Release <a href="https://github.com/ynput/OpenPype/pull/5291">#5291</a></summary>
___
</details>
### **Merged pull requests**
<details>
<summary>Maya: Refactor to new publisher <a href="https://github.com/ynput/OpenPype/pull/4388">#4388</a></summary>
<strong>**Refactor Maya to use the new publisher with new creators.**
</strong>
- [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.
___
</details>
<details>
<summary>Start script: Fix possible issues with destination drive path <a href="https://github.com/ynput/OpenPype/pull/4478">#4478</a></summary>
<strong>Drive paths for windows are fixing possibly missing slash at the end of destination path.
</strong>Windows `subst` command require to have destination path with slash if it's a drive (it should be `G:\` not `G:`).
___
</details>
<details>
<summary>Global: Move PyOpenColorIO to vendor/python <a href="https://github.com/ynput/OpenPype/pull/4946">#4946</a></summary>
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...
___
</details>
<details>
<summary>RuntimeError with Click on deadline publish <a href="https://github.com/ynput/OpenPype/pull/5065">#5065</a></summary>
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.
```
___
</details>
## [3.15.12](https://github.com/ynput/OpenPype/tree/3.15.12)

2
openpype/version.py
View file

@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
"""Package declaring Pype version."""
__version__ = "3.16.0-nightly.1"
__version__ = "3.16.0"

2
pyproject.toml
View file

@ -1,6 +1,6 @@
[tool.poetry]
name = "OpenPype"
version = "3.15.12" # OpenPype
version = "3.16.0" # OpenPype
description = "Open VFX and Animation pipeline with support."
authors = ["OpenPype Team <info@openpype.io>"]
license = "MIT License"