Package: ws-spdx-tools
Python library to to parse, validate and create SPDX documentsLinuxmacOSWindowsInformationThis library implements SPDX tag/value and RDF parsers, validators and handlers in Python.Home:https://github.com/spdx/tools-pythonIssues:https://github.com/spdx/tools-python/issuesPypi:https://pypi.python.org/pypi/spdx-toolsHistoryThis is the result of an initial GSoC contribution by @ah450(orhttps://github.com/a-h-i) and  is maintained by a community of SPDX adopters and enthusiasts.LicenseApache-2.0FeaturesAPI to create and manipulate SPDX documents.Parse and create Tag/Value, RDF, JSON, YAML, XML format SPDX filesTODOsUpdate to full SPDX v2.1Add to full license expression supportHow to useCommand-line usage:PARSER(for parsing any format):Useparser --file <filename>where<filename>is the location of the file.Try running :parser --file data/SPDXRdfExample.rdf.Or you can useparseronly and then it will automatically prompt/ask forfilename.for help - useparser --helpCONVERTOR(for converting one format to another):If I/O formats are known:Useconvertor --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.jsonIf I/O formats are not known:Useconvertor --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 enterred format of the output file.
Try running :convertor --from tag data/SPDXTagExample.in --to yaml output.outIf anyone format is known and other is not, you can use the mixture of the above two points.Ex. :convertor -f rdf data/SPDXRdfExample.xyz -o output.xmlfor help - useconvertor --helpInstallationAs always you should work in a virtualenv or venv.  You can install a local clone
of this repo withyourenv/bin/pip install .or install from PyPI withyourenv/bin/pip install spdx-tools.  Note that on Windows it would beScriptsinstead ofbin.How to run testsTests framework is using pytestpip install pytest
pytest -vvsDevelopment processWe 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-somethingMake 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-somethingMake a pull request on GitHub.Continue making more changes and commits on the branch, withgit commit --signoffandgit push.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 withrebase, if possible, or withsquash.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-somethingBesides 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.DependenciesPLY :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.SupportSubmit issues, questions or feedback at:https://github.com/spdx/tools-python/issuesJoin the chat athttps://gitter.im/spdx-org/LobbyJoin the dicussion onhttps://lists.spdx.org/g/spdx-techandhttps://spdx.dev/participate/tech/