OpenAssetIO / OpenAssetIO/OpenAssetIO-TraitGen

Alllow traitgen to generate traits to custom location

Open
#93 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
7
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Problem

We would like to include generated trait python files in our repos because they are bound to the functionality and must be versioned together with code using them. So we have trait yaml file in our project and I am generating python files from them using traitgen. Because I can't set destination, I am doing it in temporary directory and after traits are generated, I move them to final their final destination.

As a bonus (because I am aggregating multiple sources of trait definitions - more yaml files) I create on higher level __init__.py that is adding imports and and __all__ = [] declaration for easier use.

But it would be nice to just set output path.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating traitgen's handling of generated-file destinations and the entry point used to invoke generation. Add a way to select an output path so generated Python trait files are written there directly, then verify that the requested destination contains the generated files.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, yaml
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.