fix: resolve documentation and metadata discrepancies#134
Merged
Conversation
The README stated that `StandardBom` is a subclass of the CycloneDX `Bom` class. That is inaccurate: `StandardBom` uses composition — it holds a `cyclonedx.model.bom.Bom` instance in `self.bom` and exposes convenience wrappers around the upstream model objects. Correct the wording from "subclass" to "wraps" and fix the fully-qualified class path to `cyclonedx.model.bom.Bom`. Documentation-only change with no behavior or API impact.
The README examples imported `Component` and `ComponentType` from `siemens_standard_bom.model`. Those names are upstream CycloneDX model classes, not part of this package's explicit public exports. Import them from `cyclonedx.model.component` instead so the examples work cleanly for consumers using strict type checking and `implicit_reexport = False`.
hakandilek
force-pushed
the
fix/ambiguities
branch
from
3f3d45e to
7d61e6e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Corrects non-functional discrepancies in documentation and project metadata. No library behavior changes.
Changes
StandardBomis a subclass ofcyclonedx.model.bom.Bom; it is a wrapper (composition).Component/ComponentTypefromcyclonedx.model.componentin the code examples instead of re-importing them fromsiemens_standard_bom.model(breaks under the strict-mypy setup the README recommends).Testing
poetry run tox run— lint (flake8), types (mypy strict), unit tests on Python 3.10–3.14.Notes