spdx / spec-parser

automagically process the specification

spec-parser

Automagically process the model of the SPDXv3 specification to validate input or to generate stuff.

Usage

python3 ./main.py  -h 
usage: main.py [-h] [-d] [-f] [-n] [-q] [-v] [-V] input_dir [output_dir]

Generate documentation from an SPDX 3.0 model

positional arguments:
  input_dir       Directory containing the input specification files
  output_dir      Directory to write the output files to

options:
  -h, --help      show this help message and exit
  -d, --debug     Print debug output
  -f, --force     Overwrite existing generated files
  -n, --nooutput  Do not generate anything, only check input
  -q, --quiet     Print no output
  -v, --verbose   Print verbose output
  -V, --version   show program's version number and exit

Note that not all flags are functional yet.

Checking input

python3 main.py -n some/where/.../model

Note that no dependencies are needed.

Generate output

python3 -m pip install -r requirements.txt
python3 main.py some/where/.../model some/where/else/.../output_dir

Current status (mostly complete / in progress)

• parse everything in model
• generate mkdocs input
• generate JSON dump
• generate diagrams
• generate RDF ontology
• generate JSON-LD context

Contributing

Contributions are always welcome!

Feel free to open issues for any behavior that is (or even simply does not seem) correct.

However, due to the pressure for releasing SPDXv3, development is happening in fast mode, and not always refelcted in this repository. To save everyone valuable time, if you want to contribute code: clearly indicate in the corresponding issue your willingness to work on it, and wait for the assignment of the issue to you.