AYON CPP API

An API Wrapper for AYON server written in cpp

Note

we use git-Submodules to pull in external dependencys so you might want to use these commands git clone --recurse-submodules [email protected]:ynput/ayon-cpp-api.git to clone the repo with all its submodules.
git submodule update --init --recursive to initialize the Submodules when you change the branch

Note

we use tags in our .gitmodules in order to give a better overview towards the used Submodules used in this repo. you might need those commands if you change Submodule tags.

git submodule sync
git submodule update --remote

Requirements:

• C++ Compiler
• Cmake
• Python
• pip

Tested Platforms:

• Alma Linux9
• win 11

Include via Cmake

add_subdirectory("ayon-cpp-api")
include_directories("ayon-cpp-api")
target_link_libraries(Your-App AyonCppApi)

Build Steps

The build setup recently moved from a .sh/.bat file into python in order to allow for easy Usage. The python setup also includes optional tests.

The python setup exposes functions to the CLI, and it can be run with every python executable. But you will need pip for the Automatic package Installation.

Set up the build Env

{python} AyonBuild.py setup # Sets up the Venv and artifact's folder

Run one off the following build Setups

{python} AyonBuild.py runStageGRP CleanBuild # Only build the Api

{python} AyonBuild.py runStageGRP CleanBuildAndDocs # Build the Api and generate the Docs

Usage / Config

Using environment variables to Control the API

The AyonLogger can be controlled with these environment variables:

variable	value
AYONLOGGERLOGLVL	INFO ERROR WARN CRITICAL OFF
AYONLOGGERFILELOGGING	OFF / ON
AYONLOGGERFILEPOS	/path/to or ./relative/path
AYON_LOGGIN_LOGGIN_KEYS	AyonApi/AyonApiDebugEnvVars/

The AyonCppApi needs these Env Variables to function (They will typically be supplied by your Ayon Launch Env)

variable	value
AYON_API_KEY	ApiKey / BearerToken for your Ayon server
AYON_SERVER_URL	http / https addres off your Ayon server
AYON_SITE_ID	the side Id that Ayon launcher asinged to your machine
AYON_PROJECT_NAME	the Project name you want to work agains

Usage (Dev)

you can find even more Docs in the connected DoxyGen Site. You can Generate yourself an instance via the auto_docs.py in the Docs/src fouler (This will use Python to host a simple http server on port 8009 for displaying) or Check out the newest Release on the Docs Page