Python library to parse, validate and create SPDX documents
This library implements SPDX tag/value and RDF parsers, validators and handlers in Python.
- Home: https://github.com/spdx/tools-python
- Issues: https://github.com/spdx/tools-python/issues
- Pypi: https://pypi.python.org/pypi/spdx-tools
- API to create and manipulate SPDX documents.
- Parse and create Tag/Value, RDF, JSON, YAML, XML format SPDX files
- Update to full SPDX v2.2.1(ISO 5962:2021)
- Add to full license expression support
How to use
- PARSER (for parsing any format):
parser --file <filename>where
<filename>is the location of the file.
Try running :
parser --file data/SPDXRdfExample.rdf.
Or you can use
parseronly and then it will automatically prompt/ask for
for help - use
- CONVERTOR (for converting one format to another):
If I/O formats are known:
convertor --infile/-i <input_file> --outfile/-o <output_file>where
<input_file>is the location of the file to be converted (Note: only RDF and Tag formated supported) and
<output_file>is the location of the output file.
Try running :
convertor --infile data/SPDXRdfExample.rdf --outfile output.json
If I/O formats are not known:
convertor --from/-f <input_format> <input_file> --to/-t <output_format> <output_file>where
<input_format>is the manually enterred format of the input file (can be either rdf or tag) and
<out_format>(can be tag, rdf, json, yaml, xml) is the manually entered format of the output file. Try running :
convertor --from tag data/SPDXTagExample.in --to yaml output.out
If anyone of the format is known and other is not, you can use the mixture of the above two points.
convertor -f rdf data/SPDXRdfExample.xyz -o output.xml
for help - use
As always you should work in a virtualenv or venv. You can install a local clone
of this repo with
yourenv/bin/pip install . or install from PyPI with
yourenv/bin/pip install spdx-tools. Note that on Windows it would be
How to run tests
Tests framework is using pytest
pip install pytest pytest -vvs
We use the GitHub flow that is described here: https://guides.github.com/introduction/flow/
So, whenever we have to make some changes to the code, we should follow these steps:
- Create a new branch:
git checkout -b fix-or-improve-something
- Make some changes and the first commit(s) to the branch:
git commit --signoff -m 'What changes we did'
- Push the branch to GitHub:
git push origin fix-or-improve-something
- Make a pull request on GitHub.
- Continue making more changes and commits on the branch, with
git commit --signoffand
- When done, write a comment on the PR asking for a code review.
- Some other developer will review your changes and accept your PR. The merge should be done with
rebase, if possible, or with
- The temporary branch on GitHub should be deleted (there is a button for deleting it).
- Delete the local branch as well:
git checkout master git pull -p git branch -a git branch -d fix-or-improve-something
Besides this, another requirement is that every change should be made to fix or close an issue: https://guides.github.com/features/issues/ If there is no issue for the changes that you want to make, create first an issue about it that describes what needs to be done, assign it to yourself, and then start working for closing it.
- PLY : https://pypi.python.org/pypi/ply/ used for parsing.
- rdflib : https://pypi.python.org/pypi/rdflib/ for handling RDF.
- PyYAML: https://pypi.org/project/PyYAML/ for handling YAML.
- xmltodict: https://pypi.org/project/xmltodict/ for handling XML.