CycloneDX / CycloneDX/cyclonedx-python-lib

[FEAT] Define hierarchical and flat merge methods

Open
#909 9 comments 0 reactions 0 assignees View on GitHub
contrib enhancement
Dominant language
Python
Stars
116
Forks
67
Avg merge
8d 2h
Merged PRs (30d)
2

Description

The C# Library and the CLI tool expose to the user the methods for merging different SBOMs using either hierarchical or flat strategies. This is completely absent in the python library and forces to user to write them leading to differences in implementations. Would it make sense to expose this function/method? The C# library HierarchicalMerge function takes in a list of boms and the merge component, so i guess it would be something like

```python
def hierachical_merge(boms, metadata_component):
# merge stuff
return merged_bom
```
while the flat merge

```python
def flat_merge(boms):
return merged_bom
```

Contributor guide

Open the contributing guide

Research direction

Start by comparing the C# library's HierarchicalMerge behavior with the CLI's hierarchical and flat merge methods, then determine the corresponding public API for the Python library. The issue proposes hierachical_merge(boms, metadata_component) and flat_merge(boms); done means both strategies are exposed with behavior consistent with the existing implementations and documented for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.