Basic API usage

Loading components from a uSWID-format container:

from uswid import uSwidFormatUswid

with open(filename, "rb") as f:
    for component in uSwidFormatUswid().load(f.read()):
        print(f"{component!s}")

Loading components from a possible PE file:

import pefile
from uswid import uSwidFormatCoswid

try:
    with open(filename, "rb") as f:
        pe = pefile.PE(data=f.read())
    for sect in pe.sections:
        if sect.Name == b".sbom\0\0\0":
            for component in uSwidFormatCoswid().load(sect.get_data()):
                print(f"{component!s}")
except pefile.PEFormatError:
    # not a PE file, which is fine
    pass

Creating a new component, entity and payload:

from uswid import (
    uSwidComponent,
    uSwidEntity,
    uSwidEntityRole,
    uSwidPayload,
    uSwidHash,
)

component = uSwidComponent(
    tag_id="foo",
    software_name="bar",
    software_version="baz",
)
component.add_entity(
    uSwidEntity(
        name="me",
        regid="example.domain",
        roles=[uSwidEntityRole.TAG_CREATOR, uSwidEntityRole.DISTRIBUTOR],
    )
)
payload = uSwidPayload(name="foo.bin", size=123)
payload.add_hash(
    uSwidHash(
        alg_id=uSwidHashAlg.SHA256,
        value="067cb8292dc062eabbe05734ef7987eb1333b6b6",
    )
)
component.add_payload(payload)

Saving all three to an XML SWID file:

from uswid import uSwidContainer, uSwidFormatSwid

with open(filename, "rw") as f:
    f.write(uSwidFormatSwid().save(uSwidContainer([component])))