Python SPDX Library to parse, validate and create SPDX documents
This library implements an SPDX tag/value and RDF parser, validator and handler in Python. This is the result of an initial GSoC contribution by @ah450 (or https://github.com/a-h-i) and is maintained by a community of SPDX adopters and enthusiasts.
- API to create and manipulate SPDX documents.
- Parse and create Tag/Value, RDF, JSON, YAML, XML format SPDX files
- Update to full SPDX v2.1
- Add to full license expression support
How to use
Example tag/value parsing usage:
from spdx.parsers.tagvalue import Parser from spdx.parsers.tagvaluebuilders import Builder from spdx.parsers.loggers import StandardLogger p = Parser(Builder(), StandardLogger()) p.build() # data is a string containing the SPDX file. document, error = p.parse(data)
examples directory contains several code samples. Here some of them:
parse_tv.pyis an example tag/value parsing usage. Try running
python parse_tv.py ../data/SPDXSimpleTag.tag
write_tv.pyprovides an example of writing tag/value files. Run
python write_tv.py sample.tagto test it.
pp_tv.pydemonstrates how to pretty-print a tag/value file. To test it run
python pp_tv.py ../data/SPDXTagExample.tag pretty.tag.
parse_rdf.pydemonstrates how to parse an RDF file and print out document information. To test it run
python parse_rdf.py ../data/SPDXRdfExample.rdf
rdf_to_tv.pydemonstrates how to convert an RDF file to a tag/value one. To test it run
python rdf_to_tv.py ../data/SPDXRdfExample.rdf converted.tag
pp_rdf.pydemonstrates how to pretty-print an RDF file, to test it run
python pp_rdf.py ../data/SPDXRdfExample.rdf pretty.rdf
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
From the project root directory run:
python setup.py test.
You can use another test runner such as pytest or nose at your preference.
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.