What are dependency package and how to update them?

What are dependency packages?

Dependency packages are Python modules needed by the client code of the pipeline integration addons within a bundle.
These packages are created using the ayon-dependencies-tool, which resolves the pyproject.toml files of all client code for addons within the specified bundle.
This process results in a single dependency package for that bundle. These packages can often be reused if the dependencies remain unchanged.

Get official dependency package

When updating Pipeline to the latest Release on your server, you’ll receive an updated dependency package compatible with the official latest AYON bundle release.

Create and update a dependency package

For custom bundles, you’ll likely need to create your custom dependency package.

Here are steps to use ayon-dependencies-tool to create a dependency package, upload it to your AYON server, and automatically add the package to your bundle.

  1. Clone ayon-dependencies-tool
  2. Add your .env file to the ayon-dependencies-tool directory. Required environment variables:
    AYON_SERVER_URL=http://localhost:5000/
    AYON_API_KEY=<your-ayon-api-key>
    
  3. Run the following commands. Find more information in the repo’s README on GitHub:
    cd ayon-dependencies-tool
    .\start.ps1 set-env
    .\start.ps1 install
    .\start.ps1 create -b <your_bundle_name>
    
2 Likes