"]
license = "MIT License"
@@ -40,6 +40,7 @@ clique = "1.6.*"
Click = "^7"
dnspython = "^2.1.0"
ftrack-python-api = "2.0.*"
+gazu = "^0.8"
google-api-python-client = "^1.12.8" # sync server google support (should be separate?)
jsonschema = "^2.6.0"
keyring = "^22.0.1"
@@ -64,7 +65,7 @@ jinxed = [
python3-xlib = { version="*", markers = "sys_platform == 'linux'"}
enlighten = "^1.9.0"
slack-sdk = "^3.6.0"
-requests = "2.25.1"
+requests = "^2.25.1"
pysftp = "^0.2.9"
dropbox = "^11.20.0"
@@ -126,8 +127,8 @@ url = "https://distribute.openpype.io/thirdparty/ffmpeg-4.4-macos.tgz"
hash = "95f43568338c275f80dc0cab1e1836a2e2270f856f0e7b204440d881dd74fbdb"
[openpype.thirdparty.oiio.windows]
-url = "https://distribute.openpype.io/thirdparty/oiio_tools-2.2.0-windows.zip"
-hash = "fd2e00278e01e85dcee7b4a6969d1a16f13016ec16700fb0366dbb1b1f3c37ad"
+url = "https://distribute.openpype.io/thirdparty/oiio_tools-2.3.10-windows.zip"
+hash = "b9950f5d2fa3720b52b8be55bacf5f56d33f9e029d38ee86534995f3d8d253d2"
[openpype.thirdparty.oiio.linux]
url = "https://distribute.openpype.io/thirdparty/oiio_tools-2.2.12-linux.tgz"
diff --git a/schema/session-3.0.json b/schema/session-3.0.json
new file mode 100644
index 0000000000..9f785939e4
--- /dev/null
+++ b/schema/session-3.0.json
@@ -0,0 +1,81 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+
+ "title": "openpype:session-3.0",
+ "description": "The Avalon environment",
+
+ "type": "object",
+
+ "additionalProperties": true,
+
+ "required": [
+ "AVALON_PROJECT",
+ "AVALON_ASSET"
+ ],
+
+ "properties": {
+ "AVALON_PROJECTS": {
+ "description": "Absolute path to root of project directories",
+ "type": "string",
+ "example": "/nas/projects"
+ },
+ "AVALON_PROJECT": {
+ "description": "Name of project",
+ "type": "string",
+ "pattern": "^\\w*$",
+ "example": "Hulk"
+ },
+ "AVALON_ASSET": {
+ "description": "Name of asset",
+ "type": "string",
+ "pattern": "^\\w*$",
+ "example": "Bruce"
+ },
+ "AVALON_TASK": {
+ "description": "Name of task",
+ "type": "string",
+ "pattern": "^\\w*$",
+ "example": "modeling"
+ },
+ "AVALON_APP": {
+ "description": "Name of host",
+ "type": "string",
+ "pattern": "^\\w*$",
+ "example": "maya2016"
+ },
+ "AVALON_DB": {
+ "description": "Name of database",
+ "type": "string",
+ "pattern": "^\\w*$",
+ "example": "avalon",
+ "default": "avalon"
+ },
+ "AVALON_LABEL": {
+ "description": "Nice name of Avalon, used in e.g. graphical user interfaces",
+ "type": "string",
+ "example": "Mindbender",
+ "default": "Avalon"
+ },
+ "AVALON_TIMEOUT": {
+ "description": "Wherever there is a need for a timeout, this is the default value.",
+ "type": "string",
+ "pattern": "^[0-9]*$",
+ "default": "1000",
+ "example": "1000"
+ },
+ "AVALON_INSTANCE_ID": {
+ "description": "Unique identifier for instances in a working file",
+ "type": "string",
+ "pattern": "^[\\w.]*$",
+ "default": "avalon.instance",
+ "example": "avalon.instance"
+ },
+ "AVALON_CONTAINER_ID": {
+ "description": "Unique identifier for a loaded representation in a working file",
+ "type": "string",
+ "pattern": "^[\\w.]*$",
+ "default": "avalon.container",
+ "example": "avalon.container"
+ }
+ }
+}
diff --git a/setup.py b/setup.py
index 899e9375c0..8b5a545c16 100644
--- a/setup.py
+++ b/setup.py
@@ -106,7 +106,9 @@ install_requires = [
"dns",
# Python defaults (cx_Freeze skip them by default)
"dbm",
- "sqlite3"
+ "sqlite3",
+ "dataclasses",
+ "timeit"
]
includes = []
diff --git a/start.py b/start.py
index 38eb9e9bf4..ace33ab92a 100644
--- a/start.py
+++ b/start.py
@@ -266,18 +266,9 @@ def set_openpype_global_environments() -> None:
"""Set global OpenPype's environments."""
import acre
- try:
- from openpype.settings import get_general_environments
+ from openpype.settings import get_general_environments
- general_env = get_general_environments()
-
- except Exception:
- # Backwards compatibility for OpenPype versions where
- # `get_general_environments` does not exists yet
- from openpype.settings import get_environments
-
- all_env = get_environments()
- general_env = all_env["global"]
+ general_env = get_general_environments()
merged_env = acre.merge(
acre.parse(general_env),
@@ -395,18 +386,6 @@ def set_modules_environments():
modules_manager = ModulesManager()
module_envs = modules_manager.collect_global_environments()
- publish_plugin_dirs = modules_manager.collect_plugin_paths()["publish"]
-
- # Set pyblish plugins paths if any module want to register them
- if publish_plugin_dirs:
- publish_paths_str = os.environ.get("PYBLISHPLUGINPATH") or ""
- publish_paths = publish_paths_str.split(os.pathsep)
- _publish_paths = {
- os.path.normpath(path) for path in publish_paths if path
- }
- for path in publish_plugin_dirs:
- _publish_paths.add(os.path.normpath(path))
- module_envs["PYBLISHPLUGINPATH"] = os.pathsep.join(_publish_paths)
# Merge environments with current environments and update values
if module_envs:
@@ -906,6 +885,56 @@ def _bootstrap_from_code(use_version, use_staging):
return version_path
+def _boot_validate_versions(use_version, local_version):
+ _print(f">>> Validating version [ {use_version} ]")
+ openpype_versions = bootstrap.find_openpype(include_zips=True,
+ staging=True)
+ openpype_versions += bootstrap.find_openpype(include_zips=True,
+ staging=False)
+ v: OpenPypeVersion
+ found = [v for v in openpype_versions if str(v) == use_version]
+ if not found:
+ _print(f"!!! Version [ {use_version} ] not found.")
+ list_versions(openpype_versions, local_version)
+ sys.exit(1)
+
+ # print result
+ version_path = bootstrap.get_version_path_from_list(
+ use_version, openpype_versions
+ )
+ valid, message = bootstrap.validate_openpype_version(version_path)
+ _print("{}{}".format(">>> " if valid else "!!! ", message))
+
+
+def _boot_print_versions(use_staging, local_version, openpype_root):
+ if not use_staging:
+ _print("--- This will list only non-staging versions detected.")
+ _print(" To see staging versions, use --use-staging argument.")
+ else:
+ _print("--- This will list only staging versions detected.")
+ _print(" To see other version, omit --use-staging argument.")
+
+ openpype_versions = bootstrap.find_openpype(include_zips=True,
+ staging=use_staging)
+ if getattr(sys, 'frozen', False):
+ local_version = bootstrap.get_version(Path(openpype_root))
+ else:
+ local_version = OpenPypeVersion.get_installed_version_str()
+
+ list_versions(openpype_versions, local_version)
+
+
+def _boot_handle_missing_version(local_version, use_staging, message):
+ _print(message)
+ if os.environ.get("OPENPYPE_HEADLESS_MODE") == "1":
+ openpype_versions = bootstrap.find_openpype(
+ include_zips=True, staging=use_staging
+ )
+ list_versions(openpype_versions, local_version)
+ else:
+ igniter.show_message_dialog("Version not found", message)
+
+
def boot():
"""Bootstrap OpenPype."""
@@ -975,30 +1004,7 @@ def boot():
local_version = OpenPypeVersion.get_installed_version_str()
if "validate" in commands:
- _print(f">>> Validating version [ {use_version} ]")
- openpype_versions = bootstrap.find_openpype(include_zips=True,
- staging=True)
- openpype_versions += bootstrap.find_openpype(include_zips=True,
- staging=False)
- v: OpenPypeVersion
- found = [v for v in openpype_versions if str(v) == use_version]
- if not found:
- _print(f"!!! Version [ {use_version} ] not found.")
- list_versions(openpype_versions, local_version)
- sys.exit(1)
-
- # print result
- result = bootstrap.validate_openpype_version(
- bootstrap.get_version_path_from_list(
- use_version, openpype_versions))
-
- _print("{}{}".format(
- ">>> " if result[0] else "!!! ",
- bootstrap.validate_openpype_version(
- bootstrap.get_version_path_from_list(
- use_version, openpype_versions)
- )[1])
- )
+ _boot_validate_versions(use_version, local_version)
sys.exit(1)
if not openpype_path:
@@ -1008,21 +1014,7 @@ def boot():
os.environ["OPENPYPE_PATH"] = openpype_path
if "print_versions" in commands:
- if not use_staging:
- _print("--- This will list only non-staging versions detected.")
- _print(" To see staging versions, use --use-staging argument.")
- else:
- _print("--- This will list only staging versions detected.")
- _print(" To see other version, omit --use-staging argument.")
- _openpype_root = OPENPYPE_ROOT
- openpype_versions = bootstrap.find_openpype(include_zips=True,
- staging=use_staging)
- if getattr(sys, 'frozen', False):
- local_version = bootstrap.get_version(Path(_openpype_root))
- else:
- local_version = OpenPypeVersion.get_installed_version_str()
-
- list_versions(openpype_versions, local_version)
+ _boot_print_versions(use_staging, local_version, OPENPYPE_ROOT)
sys.exit(1)
# ------------------------------------------------------------------------
@@ -1035,12 +1027,7 @@ def boot():
try:
version_path = _find_frozen_openpype(use_version, use_staging)
except OpenPypeVersionNotFound as exc:
- message = str(exc)
- _print(message)
- if os.environ.get("OPENPYPE_HEADLESS_MODE") == "1":
- list_versions(openpype_versions, local_version)
- else:
- igniter.show_message_dialog("Version not found", message)
+ _boot_handle_missing_version(local_version, use_staging, str(exc))
sys.exit(1)
except RuntimeError as e:
@@ -1059,12 +1046,7 @@ def boot():
version_path = _bootstrap_from_code(use_version, use_staging)
except OpenPypeVersionNotFound as exc:
- message = str(exc)
- _print(message)
- if os.environ.get("OPENPYPE_HEADLESS_MODE") == "1":
- list_versions(openpype_versions, local_version)
- else:
- igniter.show_message_dialog("Version not found", message)
+ _boot_handle_missing_version(local_version, use_staging, str(exc))
sys.exit(1)
# set this to point either to `python` from venv in case of live code
diff --git a/tests/lib/testing_classes.py b/tests/lib/testing_classes.py
index 7dfbf6fd0d..f991f02227 100644
--- a/tests/lib/testing_classes.py
+++ b/tests/lib/testing_classes.py
@@ -153,7 +153,7 @@ class ModuleUnitTest(BaseTest):
Database prepared from dumps with 'db_setup' fixture.
"""
- from avalon.api import AvalonMongoDB
+ from openpype.pipeline import AvalonMongoDB
dbcon = AvalonMongoDB()
dbcon.Session["AVALON_PROJECT"] = self.TEST_PROJECT_NAME
yield dbcon
diff --git a/website/docs/admin_hosts_nuke.md b/website/docs/admin_hosts_nuke.md
new file mode 100644
index 0000000000..bab63223ce
--- /dev/null
+++ b/website/docs/admin_hosts_nuke.md
@@ -0,0 +1,18 @@
+---
+id: admin_hosts_nuke
+title: Nuke
+sidebar_label: Nuke
+---
+
+## Custom Menu
+You can add your custom tools menu into Nuke by extending definitions in **Nuke -> Scripts Menu Definition**.
+
+
+:::note Work in progress
+This is still work in progress. Menu definition will be handled more friendly with widgets and not
+raw json.
+:::
+
+## Gizmo Menu
+You can add your custom toolbar menu into Nuke by setting your gizmo path and extending definitions in **Nuke -> Gizmo Menu**.
+
diff --git a/website/docs/artist_hosts_maya.md b/website/docs/artist_hosts_maya.md
index 73e89384e8..48e1093753 100644
--- a/website/docs/artist_hosts_maya.md
+++ b/website/docs/artist_hosts_maya.md
@@ -312,6 +312,10 @@ Example setup:
+:::note Publish on farm
+If your studio has Deadline configured, artists could choose to offload potentially long running export of pointache and publish it to the farm.
+Only thing that is necessary is to toggle `Farm` property in created pointcache instance to True.
+
### Loading Point Caches
Loading point cache means creating reference to **abc** file with Go **OpenPype β Load...**.
diff --git a/website/docs/artist_kitsu.md b/website/docs/artist_kitsu.md
new file mode 100644
index 0000000000..9ef782c297
--- /dev/null
+++ b/website/docs/artist_kitsu.md
@@ -0,0 +1,17 @@
+---
+id: artist_kitsu
+title: Kitsu
+sidebar_label: Kitsu
+---
+
+# How to use Kitsu in OpenPype
+
+## Login to Kitsu module in OpenPype
+1. Launch OpenPype, the `Kitsu Credentials` window will open automatically, if not, or if you want to log-in with another account, go to systray OpenPype icon and click on `Kitsu Connect`.
+2. Enter your credentials and press *Ok*:
+
+ 
+
+:::tip
+In Kitsu, All the publish actions executed by `pyblish` will be attributed to the currently logged-in user.
+:::
\ No newline at end of file
diff --git a/website/docs/assets/kitsu/kitsu_credentials.png b/website/docs/assets/kitsu/kitsu_credentials.png
new file mode 100644
index 0000000000..25c1ad93c4
Binary files /dev/null and b/website/docs/assets/kitsu/kitsu_credentials.png differ
diff --git a/website/docs/assets/nuke-admin_gizmomenu.png b/website/docs/assets/nuke-admin_gizmomenu.png
new file mode 100644
index 0000000000..81e63b2041
Binary files /dev/null and b/website/docs/assets/nuke-admin_gizmomenu.png differ
diff --git a/website/docs/assets/nuke-admin_scriptsmenu.png b/website/docs/assets/nuke-admin_scriptsmenu.png
new file mode 100644
index 0000000000..cad2a4411d
Binary files /dev/null and b/website/docs/assets/nuke-admin_scriptsmenu.png differ
diff --git a/website/docs/module_kitsu.md b/website/docs/module_kitsu.md
new file mode 100644
index 0000000000..ec38cce5e1
--- /dev/null
+++ b/website/docs/module_kitsu.md
@@ -0,0 +1,37 @@
+---
+id: module_kitsu
+title: Kitsu Administration
+sidebar_label: Kitsu
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+Kitsu is a great open source production tracker and can be used for project management instead of Ftrack. This documentation assumes that you are familiar with Kitsu and it's basic principles. If you're new to Kitsu, we recommend having a thorough look at [Kitsu Official Documentation](https://kitsu.cg-wire.com/).
+
+## Prepare Kitsu for OpenPype
+
+### Server URL
+If you want to connect Kitsu to OpenPype you have to set the `Server` url in Kitsu settings. And that's all!
+This setting is available for all the users of the OpenPype instance.
+
+## Synchronize
+Updating OP with Kitsu data is executed running the `sync-service`, which requires to provide your Kitsu credentials with `-l, --login` and `-p, --password` or by setting the environment variables `KITSU_LOGIN` and `KITSU_PWD`. This process will request data from Kitsu and create/delete/update OP assets.
+Once this sync is done, the thread will automatically start a loop to listen to Kitsu events.
+
+```bash
+openpype_console module kitsu sync-service -l me@domain.ext -p my_password
+```
+
+### Events listening
+Listening to Kitsu events is the key to automation of many tasks like _project/episode/sequence/shot/asset/task create/update/delete_ and some more. Events listening should run at all times to perform the required processing as it is not possible to catch some of them retrospectively with strong reliability. If such timeout has been encountered, you must relaunch the `sync-service` command to run the synchronization step again.
+
+### Push to Kitsu
+An utility function is provided to help update Kitsu data (a.k.a Zou database) with OpenPype data if the publishing to the production tracker hasn't been possible for some time. Running `push-to-zou` will create the data on behalf of the user.
+:::caution
+This functionality cannot deal with all cases and is not error proof, some intervention by a human being might be required.
+:::
+
+```bash
+openpype_console module kitsu push-to-zou -l me@domain.ext -p my_password
+```
diff --git a/website/sidebars.js b/website/sidebars.js
index 105afc30eb..ee816dd678 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -28,6 +28,7 @@ module.exports = {
"artist_hosts_photoshop",
"artist_hosts_tvpaint",
"artist_hosts_unreal",
+ "artist_kitsu",
{
type: "category",
label: "Ftrack",
@@ -75,6 +76,7 @@ module.exports = {
label: "Modules",
items: [
"module_ftrack",
+ "module_kitsu",
"module_site_sync",
"module_deadline",
"module_muster",
@@ -88,6 +90,7 @@ module.exports = {
items: [
"admin_hosts_blender",
"admin_hosts_maya",
+ "admin_hosts_nuke",
"admin_hosts_resolve",
"admin_hosts_harmony",
"admin_hosts_aftereffects",
diff --git a/website/src/pages/index.js b/website/src/pages/index.js
index d9bbc3eaa0..f57fd1002a 100644
--- a/website/src/pages/index.js
+++ b/website/src/pages/index.js
@@ -299,6 +299,11 @@ function Home() {
Maya
+
+
+ 
+ Flame
+
@@ -306,7 +311,7 @@ function Home() {
-
+ 
Nuke Studio
@@ -374,12 +379,17 @@ function Home() {
Deadline
-
+
Muster
+
+ 
+ Royal Render
+
+
Slack
@@ -390,10 +400,10 @@ function Home() {
In development by us or OpenPype community.
+ Multiverse
diff --git a/website/static/img/app_flame.png b/website/static/img/app_flame.png
index ba9b69e45f..188153e573 100644
Binary files a/website/static/img/app_flame.png and b/website/static/img/app_flame.png differ
diff --git a/website/static/img/app_hiero.png b/website/static/img/app_hiero.png
index ea33f10214..ef27f58bee 100644
Binary files a/website/static/img/app_hiero.png and b/website/static/img/app_hiero.png differ
diff --git a/website/static/img/app_multiverse.png b/website/static/img/app_multiverse.png
new file mode 100644
index 0000000000..c0d80e4f1b
Binary files /dev/null and b/website/static/img/app_multiverse.png differ
diff --git a/website/static/img/app_nuke.png b/website/static/img/app_nuke.png
index 4b3797af7a..1465da8ce8 100644
Binary files a/website/static/img/app_nuke.png and b/website/static/img/app_nuke.png differ
diff --git a/website/static/img/app_nukestudio.png b/website/static/img/app_nukestudio.png
new file mode 100644
index 0000000000..dfc2ad5a97
Binary files /dev/null and b/website/static/img/app_nukestudio.png differ
diff --git a/website/static/img/app_royalrender.png b/website/static/img/app_royalrender.png
new file mode 100644
index 0000000000..0e49519227
Binary files /dev/null and b/website/static/img/app_royalrender.png differ