Skip to main content

AYON server API

Python client for connection server. The client is using REST and GraphQl to communicate with server with requests module.

AYON Python api should support connection to server with raw REST functions and prepared functionality for work with entities. Must not contain only functionality that can be used with core server functionality.

Module support singleton connection which is using AYON_SERVER_URL and AYON_API_KEY environment variables as source for connection. The singleton connection is using ServerAPI object. There can be created multiple connection to different server at one time, for that purpose use ServerAPIBase object.

Install

AYON python api is available on PyPi:

pip install ayon-python-api

For development purposes you may follow build guide to build and install custom wheels.

Cloning the repository

Repository does not have submodules or special cases. Clone is simple as:

git clone git@github.com:ynput/ayon-python-api.git

Build wheel

For wheel build is required a build module from PyPi:

pip install build

Open terminal and change directory to ayon-python-api repository and build wheel:

cd <REPOSITORY ROOT>/ayon-python-api
python -m build

Once finished a wheel should be created in ./dist/ayon_python_api-<VERSION>-py3-none-any.


Wheel installation

The wheel file can be used to install using pip:

pip install <REPOSITORY ROOT>/dist/ayon_python_api-<VERSION>-py3-none-any

If pip complain that ayon-python-api is already installed just uninstall existing one first:

pip uninstall ayon-python-api

TODOs

  • Find more suitable name of ServerAPI objects (right now is used con or connection)
  • Add all available CRUD operation on entities using REST
  • Add folder and task changes to operations
  • Enhance entity hub
    • Missing docstrings in EntityHub -> especially entity arguments are missing
    • Better order of arguments for entity classes
      • Move entity hub to first place
      • Skip those which are invalid for the entity and fake it for base or remove it from base
    • Entity hub should use operations session to do changes
    • Entity hub could also handle 'product', 'version' and 'representation' entities
    • Missing 'status' on folders
    • Missing assignees on tasks
    • Pass docstrings and arguments definitions from ServerAPI methods to global functions
  • Split ServerAPI into smaller chunks (somehow), the class has 4k+ lines of code
  • Add .pyi stub for ServerAPI
  • Missing websockets connection

Metadata

Release files for ayon-python-api 1.2.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ayon-python-api 1.2.26
File Size Uploaded Provenance Actions
ayon_python_api-1.2.26.tar.gz 248.1 kB Without provenance Details for ayon_python_api-1.2.26.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ayon-python-api 1.2.26
File Interpreter ABI Platform Actions
ayon_python_api-1.2.26-py3-none-any.whl Python 3 none any Details for ayon_python_api-1.2.26-py3-none-any.whl

Total release size: 464.0 kB

Release files / ayon_python_api-1.2.26.tar.gz

Download URL ayon_python_api-1.2.26.tar.gz
Size 248.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f1553057edc151be76feaa5a9c72101e0c6dade07353db6b134379054ce1249c
BLAKE2b-256 checksum
How to use checksums
17cda2f9e89ce54d6f9db26f139b216e3cc16d8c44025eaa7f024b14f7d28827
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / ayon_python_api-1.2.26-py3-none-any.whl

Download URL ayon_python_api-1.2.26-py3-none-any.whl
Size 216.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5c37d6aa220aea7146b9322f2eb61d2c1380569f64c28128c040614cc910f755
BLAKE2b-256 checksum
How to use checksums
c14d2dd84719a122eb8136547eb5d5b52d00b253e35474f6fb2b70de3219ba80
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for ayon-python-api 1.2.26

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.26 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page