OpenAssetIO / OpenAssetIO/OpenAssetIO

Support plugin path(s) variable in config file

Open
#1,033 4 comments 2 reactions 1 assignee View on GitHub

@feltech is already working on this.

Since Sep 23, 2024.

enhancement suggestion
Dominant language
C++
Stars
348
Forks
47
PR merge metrics
No merged PRs in 30d

Description

What

Support a plugin_paths variable in the OpenAssetIO config TOML, which (effectively) appends to OPENASSETIO_PLUGIN_PATH.

Why

It would reduce the setup steps for enabling a host to work with a particular manager if they only had to set one environment variable (OPENASSETIO_DEFAULT_CONFIG) instead of two.

In combination with the built-in ${config_dir} expansion, this would mean the config and plugin(s) could live together in a relocatable way.

Acceptance Criteria

The environment variable would take precedence over the config file.
platform_paths should be a TOML list
We should tolerate non existent paths, and just print a warning (which is probably already the case). This allows config files to be shared between hosts/platforms.
Needs to support C++ and Python

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.