Skip to content

fix: resolve documentation and metadata discrepancies #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hakandilek merged 3 commits into from
Jul 8, 2026
Merged

fix: resolve documentation and metadata discrepancies #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4395252
docs(README): clarify StandardBom wraps CycloneDX class
hakandilek Jul 8, 2026
0977a52
docs(README): import CycloneDX model types directly
hakandilek Jul 8, 2026
7d61e6e
chore: unify maintainer email
hakandilek Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at <jensenthomas@siemens.com>
or <hakandilek@gmail.com>. All complaints will be reviewed and investigated promptly and fairly.
or <hakan.dilek@siemens.com>. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Expand Down
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ involved. The community looks forward to your contributions. 🎉

This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to <jensenthomas@siemens.com> or <hakandilek@gmail.com>.
to <jensenthomas@siemens.com> or <hakan.dilek@siemens.com>.


## I Have a Question
Expand Down Expand Up @@ -84,7 +84,7 @@ following steps in advance to help us fix any potential bug as fast as possible.

> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue
> tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <jensenthomas@siemens.com> or
> <hakandilek@gmail.com>.
> <hakan.dilek@siemens.com>.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

Expand Down
2 changes: 1 addition & 1 deletion MAINTAINERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
# SPDX-License-Identifier: MIT

Thomas Jensen <jensenthomas@siemens.com>
Hakan Dilek <hakandilek@gmail.com>
Hakan Dilek <hakan.dilek@siemens.com>
Leo Reinmann <leo.reinmann@siemens.com>
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,14 @@ This will save the Standard BOM to the file without the `.dependencies` field, w

## Create a Standard BOM document programmatically

The `StandardBom` class is a subclass of the `cyclonedx.bom.Bom` class from the upstream library
[cyclonedx-python-lib](https://github.com/CycloneDX/cyclonedx-python-lib) since this library is a wrapper of the
model objects from the upstream library.
The `StandardBom` class wraps the `cyclonedx.model.bom.Bom` class from the upstream library
[cyclonedx-python-lib](https://github.com/CycloneDX/cyclonedx-python-lib). This library provides convenience wrappers
around model objects from the upstream library.

```python
from siemens_standard_bom.model import StandardBom, Component, ComponentType
from cyclonedx.model.component import Component, ComponentType
from cyclonedx.model.contact import OrganizationalContact
from siemens_standard_bom.model import StandardBom

bom = StandardBom()
bom.add_author(OrganizationalContact(name='John Doe'))
Expand All @@ -87,8 +88,9 @@ You can also use the Standard BOM wrapper classes to create and edit the Standar
For example, you can do the following similar to the example abode:

```python
from siemens_standard_bom.model import StandardBom, Component, ComponentType, SbomComponent
from cyclonedx.model.component import Component, ComponentType
from cyclonedx.model.contact import OrganizationalContact
from siemens_standard_bom.model import StandardBom, SbomComponent

bom = StandardBom()
bom.add_author(OrganizationalContact(name='John Doe'))
Expand Down
Loading