AYON Python API
Project description
AYON server API
Python client for connection server. Client must be (at least for some time) Python 2 compatible because will be used in DCC that are "older".
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 wheel module from PyPi:
pip install wheel
Open terminal and change directory to ayon-python-api repository and build wheel:
cd <REPOSITORY ROOT>/ayon-python-api
python setup.py sdist bdist_wheel
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
ServerAPIobjects (right now is usedconorconnection) - 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
ServerAPImethods to global functions
- Split
ServerAPIinto smaller chunks (somehow), the class has 4k+ lines of code - Add .pyi stub for ServerAPI
- Missing websockets connection
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ayon_python_api-1.0.5-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e88bfbabbaa6caa0b6d8fbd1f0306a971d85da9182f5d94e646fe88c04128aa8 |
|
| MD5 | 482c89132f3d14847ab6f5c2bcc465db |
|
| BLAKE2b-256 | a3d2f7721a958f6295311c7487b5e438ced01d884c0b669442471e3ca81284f2 |
