[issue-593] add spdx2_document_from_scratch example #598
Conversation
This file contains 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
Closed
| validation_messages: List[ValidationMessage] = validate_full_spdx_document(document) | ||
|
|
||
| # If the document is valid, validation_messages will be empty. | ||
| assert validation_messages == [] |
There was a problem hiding this comment.
I think that this should go after logging the validation messages to actually see what has to be fixed?
There was a problem hiding this comment.
You are right, that makes more sense
| # Finally, we can serialize the document to any of the five supported formats. | ||
| # Using the write_file() method from the write_anything module, | ||
| # the format will be determined by the file ending: .spdx (tag-value), .json, .xml, .yaml. or .rdf (or .rdf.xml) | ||
| write_file(document, "my_spdx_document.json") |
There was a problem hiding this comment.
According to the specification, JSON serializations should use *.spdx.json (see https://spdx.github.io/spdx-spec/v2.3/conformance/#44-standard-data-format-requirements), so I would probably stick with the recommendation here as well?
There was a problem hiding this comment.
Sure thing!
armintaenzertng
force-pushed
the
exampleDocumentFromScratch
branch
from
16247a9 to
d34454e
Compare
meretp
reviewed
Apr 19, 2023
README.md
Outdated
| @@ -94,7 +94,7 @@ instead of `bin`. | |||
|
|
|||
| ## Library usage | |||
| 1. **DATA MODEL** | |||
| * The `spdx_tools.spdx.model` package constitutes the internal SPDX v2.3 data model (v2.2 is a simply a subset of this). All relevant classes for SPDX document creation are exposed in the [__init__.py](src%2Fspdx_tools%2Fspdx%2Fmodel%2F__init__.py). | |||
| * The `spdx_tools.spdx.model` package constitutes the internal SPDX v2.3 data model (v2.2 is a simply a subset of this). All relevant classes for SPDX document creation are exposed in the `__init__.py` found [here](src%2Fspdx_tools%2Fspdx%2Fmodel%2F__init__.py). | |||
There was a problem hiding this comment.
Suggested change
| * The `spdx_tools.spdx.model` package constitutes the internal SPDX v2.3 data model (v2.2 is a simply a subset of this). All relevant classes for SPDX document creation are exposed in the `__init__.py` found [here](src%2Fspdx_tools%2Fspdx%2Fmodel%2F__init__.py). | |
| * The `spdx_tools.spdx.model` package constitutes the internal SPDX v2.3 data model (v2.2 is simply a subset of this). All relevant classes for SPDX document creation are exposed in the `__init__.py` found [here](src%2Fspdx_tools%2Fspdx%2Fmodel%2F__init__.py). |
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
armintaenzertng
force-pushed
the
exampleDocumentFromScratch
branch
from
d34454e to
3a4f8a4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
fixes #593