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 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 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

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

5 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for annatar from gravatar.com annatar Avatar for Damien.Coureau from gravatar.com Damien.Coureau Avatar for iLLiCiT from gravatar.com iLLiCiT
+2 more Avatar for milan.kolar from gravatar.com milan.kolar Avatar for ynput from gravatar.com ynput

Credits

Author: ynput.io

License

Apache License

Tags

AYON ynput OpenPype vfx

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ayon_python_api-1.2.23.tar.gz (178.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ayon_python_api-1.2.23-py3-none-any.whl (178.1 kB view details)

Uploaded Python 3

File details

Details for the file ayon_python_api-1.2.23.tar.gz.

File metadata

  • Download URL: ayon_python_api-1.2.23.tar.gz
  • Upload date:
  • Size: 178.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ayon_python_api-1.2.23.tar.gz
Algorithm Hash digest
SHA256 36cecd5b7ee95bc2392083b872aba8ecea3e365ae9812c4093625f13c2d8d60a
MD5 1bb21ffc1fea4195eed6673506b7a6a4
BLAKE2b-256 a6591bf8616b84ce3a9a3e819496168339bb4bbe4efc66266f81842c6b7dccd0

See more details on using hashes here.

File details

Details for the file ayon_python_api-1.2.23-py3-none-any.whl.

File metadata

File hashes

Hashes for ayon_python_api-1.2.23-py3-none-any.whl
Algorithm Hash digest
SHA256 93b4a47b903d7aaab8aae05098914f90777487bf9908ca9ff37f6f4e1cc067e0
MD5 478b7f76fce8ac362e6bae78ef5ff2e2
BLAKE2b-256 f63ade06959630c92080682b6d2ce162099238e660d1a56f5f2ba0652d25c539

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.2.23 This release

2 files

1.2.22

2 files

1.2.21

2 files

1.2.20

2 files

1.2.19

2 files

1.2.17

2 files

Pre-release

1.2.17.dev0

2 files

1.2.16

2 files

Pre-release

1.2.16.dev0

2 files

1.2.15

2 files

Pre-release

1.2.15.dev0

2 files

1.2.14

2 files

Pre-release

1.2.14.dev0

2 files

1.2.13

2 files

Pre-release

1.2.13.dev0

2 files

1.2.12

2 files

1.2.11

2 files

1.2.10

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Pre-release

1.0.0rc3

2 files

Pre-release

1.0.0rc2

2 files

Pre-release

1.0.0rc1

2 files

0.5.4

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

Yanked

0.4.0

2 files

Yanked reason: The release have crutial bug

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

0.1.14

2 files

0.1.13

2 files

0.1.12

2 files

0.1.11

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page