---

1. Feature: OpenStudioLandscapes-Ayon
   1. Brief
   2. Requirements
   3. Install
      1. This Feature
   4. Add to OpenStudioLandscapes
   5. Testing
      1. pre-commit
      2. nox
   6. Variables
      1. Feature Configs
2. Community
3. Official Resources
   1. Official Documentation
      1. Dev Resources

---

This README.md was dynamically created with OpenStudioLandscapesUtil-ReadmeGenerator.

---

Feature: OpenStudioLandscapes-Ayon

Brief

This is an extension to the OpenStudioLandscapes ecosystem. The full documentation of OpenStudioLandscapes is available here.

You feel like writing your own Feature? Go and check out the OpenStudioLandscapes-Template.

Requirements

• python-3.11
• OpenStudioLandscapes

Install

This Feature

Clone this repository into OpenStudioLandscapes/.features:

# cd .features
git clone https://github.com/michimussato/OpenStudioLandscapes-Ayon.git

Create venv:

# cd .features/OpenStudioLandscapes-Ayon
python3.11 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip setuptools

Configure venv:

# cd .features/OpenStudioLandscapes-Ayon
pip install -e "../../[dev]"
pip install -e ".[dev]"

For more info see VCS Support of pip.

Add to OpenStudioLandscapes

Add the following code to OpenStudioLandscapes.engine.features.FEATURES:

FEATURES.update(
    "OpenStudioLandscapes-Ayon": {
        "enabled": True|False,
        # - from ENVIRONMENT VARIABLE (.env):
        #   "enabled": get_bool_env("ENV_VAR")
        # - combined:
        #   "enabled": True|False or get_bool_env(
        #       "OPENSTUDIOLANDSCAPES__ENABLE_FEATURE_OPENSTUDIOLANDSCAPES_AYON"
        #   )
        "module": "OpenStudioLandscapes.Ayon.definitions",
        "compose_scope": ComposeScope.DEFAULT,
        "feature_config": OpenStudioLandscapesConfig.DEFAULT,
    }
)

Testing

pre-commit

• https://pre-commit.com
• https://pre-commit.com/hooks.html

pre-commit install

nox

Generate Report

nox --no-error-on-missing-interpreters --report .nox/nox-report.json

Re-Generate this README

nox -v --add-timestamp --session readme

Generate Sphinx Documentation

nox -v --add-timestamp --session docs

pylint

nox -v --add-timestamp --session lint

pylint: disable=redefined-outer-name

• W0621: Due to Dagsters way of piping arguments into assets.

SBOM

Acronym for Software Bill of Materials

nox -v --add-timestamp --session sbom

We create the following SBOMs:

• cyclonedx-bom
• pipdeptree (Dot)
• pipdeptree (Mermaid)

SBOMs for the different Python interpreters defined in .noxfile.VERSIONS will be created in the .sbom directory of this repository.

• cyclone-dx
• pipdeptree (Dot)
• pipdeptree (Mermaid)

Currently, the following Python interpreters are enabled for testing:

• python3.11

Variables

The following variables are being declared in OpenStudioLandscapes.Ayon.constants and are accessible throughout the OpenStudioLandscapes-Ayon package.

Variable	Type
DOCKER_USE_CACHE	bool
AYONDB_INSIDE_CONTAINER	bool
ASSET_HEADER	dict
FEATURE_CONFIGS	dict

Feature Configs

Feature Config: default

Variable	Type	Value
DOCKER_USE_CACHE	bool	False
CONFIGS_ROOT	str	{DOT_FEATURES}/OpenStudioLandscapes-Ayon/.payload/config
AYON_PORT_HOST	str	5005
AYON_PORT_CONTAINER	str	5000
AYON_DB_INSTALL_DESTINATION	str	{DOT_LANDSCAPES}/{LANDSCAPE}/Ayon__Ayon/data/ayon-db

Community

Feature	GitHub	Discord
OpenStudioLandscapes	https://github.com/michimussato/OpenStudioLandscapes	# openstudiolandscapes-general
OpenStudioLandscapes-Ayon	https://github.com/michimussato/OpenStudioLandscapes-Ayon	# openstudiolandscapes-ayon
OpenStudioLandscapes-Dagster	https://github.com/michimussato/OpenStudioLandscapes-Dagster	# openstudiolandscapes-dagster
OpenStudioLandscapes-Flamenco	https://github.com/michimussato/OpenStudioLandscapes-Flamenco	# openstudiolandscapes-flamenco
OpenStudioLandscapes-Flamenco-Worker	https://github.com/michimussato/OpenStudioLandscapes-Flamenco-Worker	# openstudiolandscapes-flamenco-worker
OpenStudioLandscapes-Kitsu	https://github.com/michimussato/OpenStudioLandscapes-Kitsu	# openstudiolandscapes-kitsu
OpenStudioLandscapes-RustDeskServer	https://github.com/michimussato/OpenStudioLandscapes-RustDeskServer	# openstudiolandscapes-rustdeskserver
OpenStudioLandscapes-Template	https://github.com/michimussato/OpenStudioLandscapes-Template	# openstudiolandscapes-template
OpenStudioLandscapes-VERT	https://github.com/michimussato/OpenStudioLandscapes-VERT	# openstudiolandscapes-twingate

To follow up on the previous LinkedIn publications, visit:

• OpenStudioLandscapes on LinkedIn.
• Search for tag #OpenStudioLandscapes on LinkedIn.

---

Official Resources

Ayon is written and maintained by Ynput, a company based in Czech Republic:

Ynput offers different versions of Ayon

• Community
• Pro Cloud
• Studio Cloud

OpenStudioLandscapes-Ayon is based on the Community version provided by their own Docker image:

• https://github.com/ynput/ayon-docker

Official Documentation

• Features
• User Docs
• Admin Docs
• Dev Docs

Dev Resources

• REST API Docs
• GraphQL API Explorer
• Python API Docs
• C++ API Docs
• USD Resolver Docs
• Frontend React Components

---