Move CueGUI constants to a YAML config file. #1242
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link the Issue(s) this Pull Request is related to.
#785
Summarize your change.
Prior to this change, most of the values in CueGUI's
Constants.py
could only be changed by editing the code directly. For some of those values, that was fine, as they are true constants, but that file contains a lot of settings that should be easily tweakable by users -- refresh settings, style settings, render log roots, plugin paths, etc.This change creates a new
cuegui.yaml
file where all of that config can live:Constants.py
is kept to ease the transition, for now at least.config/cuegui.yaml
. This file also provides an example users can work from to create their own config.~/.config/opencue/cuegui.yaml
on Linux/Mac.%APPDATA%/opencue/cuegui.yaml
on Windows.CUEGUI_CONFIG_FILE
env var.Config.py
is renamed toLayout.py
, as it only really deals with saving/restoring window layout, so it was confusing.CONFIG_PATH
. CurrentlyDEFAULT_INI_PATH
is used for all config files, not just.ini
files, which is confusing.cue_resources.yaml
into the new YAML file.