# Python library to to parse, validate and create SPDX documents
| Linux | macOS | Windows |
| :---- | :------ | :---- |
[ ![Linux build status][1]][2] | [![macOS build status][3]][4] | [![Windows build status][5]][6] |
[1]: https://travis-ci.org/spdx/tools-python.svg?branch=master
[2]: https://travis-ci.org/spdx/tools-python
[3]: https://circleci.com/gh/spdx/tools-python/tree/master.svg?style=shield&circle-token=36cca2dfa3639886fc34e22d92495a6773bdae6d
[4]: https://circleci.com/gh/spdx/tools-python/tree/master
[5]: https://ci.appveyor.com/api/projects/status/0bf9glha2yg9x8ef/branch/master?svg=true
[6]: https://ci.appveyor.com/project/spdx/tools-python/branch/master
# Information
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
# History
This is the result of an initial GSoC contribution by @[ah450](https://github.com/ah450)
(or https://github.com/a-h-i) and is maintained by a community of SPDX adopters and enthusiasts.
# License
[Apache-2.0](LICENSE)
# Features
* API to create and manipulate SPDX documents.
* Parse and create Tag/Value, RDF, JSON, YAML, XML format SPDX files
# TODOs
* Update to full SPDX v2.1
* Add to full license expression support
# How to use
## Command-line usage:
1. **PARSER** (for parsing any format):
* Use `parser --file <filename>` where `<filename>` is the location of the file.
Try running : `parser --file data/SPDXRdfExample.rdf`.
* Or you can use `parser` only and then it will automatically prompt/ask for `filename`.
* for help - use `parser --help`
2. **CONVERTOR** (for converting one format to another):
* If I/O formats are known:
* Use `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:
* Use `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 enterred format of the output file.
Try running : `convertor --from tag data/SPDXTagExample.in --to yaml output.out`
* If 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.xml`
* for help - use `convertor --help`
# Installation
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 `Scripts`
instead of `bin`.
# How to run tests
Tests framework is using pytest
```
pip install pytest
pytest -vvs
```
# Development process
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:
1. Create a new branch:
`git checkout -b fix-or-improve-something`
2. Make some changes and the first commit(s) to the branch:
`git commit --signoff -m 'What changes we did'`
3. Push the branch to GitHub:
`git push origin fix-or-improve-something`
4. Make a pull request on GitHub.
5. Continue making more changes and commits on the branch, with `git commit --signoff` and `git push`.
6. When done, write a comment on the PR asking for a code review.
7. Some other developer will review your changes and accept your PR. The merge should be done with `rebase`, if possible, or with `squash`.
8. The temporary branch on GitHub should be deleted (there is a button for deleting it).
9. 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.
# Dependencies
* 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.
# Support
* Submit issues, questions or feedback at: https://github.com/spdx/tools-python/issues
* Join the chat at https://gitter.im/spdx-org/Lobby
* Join the dicussion on https://lists.spdx.org/g/spdx-tech and
https://spdx.dev/participate/tech/
Raw data
{
"_id": null,
"home_page": "https://github.com/spdx/tools-python",
"name": "ws-spdx-tools",
"maintainer": "Philippe Ombredanne, SPDX group at the Linux Foundation and others",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "pombredanne@gmail.com",
"keywords": "",
"author": "Ahmed H. Ismail",
"author_email": "ahm3d.hisham@gmail.com",
"download_url": "",
"platform": null,
"description": "# Python library to to parse, validate and create SPDX documents\n\n| Linux | macOS | Windows |\n| :---- | :------ | :---- |\n[ ![Linux build status][1]][2] | [![macOS build status][3]][4] | [![Windows build status][5]][6] |\n\n[1]: https://travis-ci.org/spdx/tools-python.svg?branch=master\n[2]: https://travis-ci.org/spdx/tools-python\n[3]: https://circleci.com/gh/spdx/tools-python/tree/master.svg?style=shield&circle-token=36cca2dfa3639886fc34e22d92495a6773bdae6d\n[4]: https://circleci.com/gh/spdx/tools-python/tree/master\n[5]: https://ci.appveyor.com/api/projects/status/0bf9glha2yg9x8ef/branch/master?svg=true\n[6]: https://ci.appveyor.com/project/spdx/tools-python/branch/master\n\n\n# Information\n\nThis library implements SPDX tag/value and RDF parsers, validators and handlers in Python.\n\n- Home: https://github.com/spdx/tools-python\n- Issues: https://github.com/spdx/tools-python/issues\n- Pypi: https://pypi.python.org/pypi/spdx-tools\n\n\n# History\n\nThis is the result of an initial GSoC contribution by @[ah450](https://github.com/ah450)\n(or https://github.com/a-h-i) and is maintained by a community of SPDX adopters and enthusiasts.\n\n\n# License\n\n[Apache-2.0](LICENSE)\n\n\n# Features\n\n* API to create and manipulate SPDX documents.\n* Parse and create Tag/Value, RDF, JSON, YAML, XML format SPDX files\n\n\n# TODOs\n\n* Update to full SPDX v2.1\n* Add to full license expression support\n\n\n# How to use\n\n## Command-line usage:\n\n1. **PARSER** (for parsing any format):\n* Use `parser --file <filename>` where `<filename>` is the location of the file. \nTry running : `parser --file data/SPDXRdfExample.rdf`.\n \n* Or you can use `parser` only and then it will automatically prompt/ask for `filename`. \n\n* for help - use `parser --help` \n\n\n2. **CONVERTOR** (for converting one format to another):\n* If I/O formats are known:\n \n * Use `convertor --infile/-i <input_file> --outfile/-o <output_file>` where `<input_file>` is the location of the file to be converted \n (Note: only RDF and Tag formated supported) and `<output_file>` is the location of the output file. \n Try running : `convertor --infile data/SPDXRdfExample.rdf --outfile output.json` \n\n* If I/O formats are not known:\n\n * Use `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)\n and `<out_format>` (can be tag, rdf, json, yaml, xml) is the manually enterred format of the output file. \n Try running : `convertor --from tag data/SPDXTagExample.in --to yaml output.out` \n\n* If anyone format is known and other is not, you can use the mixture of the above two points. \nEx. : `convertor -f rdf data/SPDXRdfExample.xyz -o output.xml`\n\n* for help - use `convertor --help`\n\n\n\n# Installation\n\nAs always you should work in a virtualenv or venv. You can install a local clone\nof this repo with `yourenv/bin/pip install .` or install from PyPI with\n`yourenv/bin/pip install spdx-tools`. Note that on Windows it would be `Scripts`\ninstead of `bin`.\n\n\n# How to run tests\n\nTests framework is using pytest\n\n```\npip install pytest\npytest -vvs\n```\n\n\n# Development process\n\nWe use the GitHub flow that is described here: https://guides.github.com/introduction/flow/\n\nSo, whenever we have to make some changes to the code, we should follow these steps:\n1. Create a new branch:\n `git checkout -b fix-or-improve-something`\n2. Make some changes and the first commit(s) to the branch: \n `git commit --signoff -m 'What changes we did'`\n3. Push the branch to GitHub:\n `git push origin fix-or-improve-something`\n4. Make a pull request on GitHub.\n5. Continue making more changes and commits on the branch, with `git commit --signoff` and `git push`.\n6. When done, write a comment on the PR asking for a code review.\n7. Some other developer will review your changes and accept your PR. The merge should be done with `rebase`, if possible, or with `squash`.\n8. The temporary branch on GitHub should be deleted (there is a button for deleting it).\n9. Delete the local branch as well:\n ```\n git checkout master\n git pull -p\n git branch -a\n git branch -d fix-or-improve-something\n ```\n\nBesides this, another requirement is that every change should be made to fix or close an issue: https://guides.github.com/features/issues/\nIf 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.\n\n\n# Dependencies\n\n* PLY : https://pypi.python.org/pypi/ply/ used for parsing.\n* rdflib : https://pypi.python.org/pypi/rdflib/ for handling RDF. \n* PyYAML: https://pypi.org/project/PyYAML/ for handling YAML.\n* xmltodict: https://pypi.org/project/xmltodict/ for handling XML.\n\n\n# Support\n\n* Submit issues, questions or feedback at: https://github.com/spdx/tools-python/issues\n* Join the chat at https://gitter.im/spdx-org/Lobby\n* Join the dicussion on https://lists.spdx.org/g/spdx-tech and \n https://spdx.dev/participate/tech/\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "SPDX parser and tools.",
"version": "0.7.0a4.post6",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "c08307fcba21e671d4a046e558b6b2d1",
"sha256": "ea55a919b32f57f975a8a323718324379372768daba38f92438f6c6f22e0c29b"
},
"downloads": -1,
"filename": "ws_spdx_tools-0.7.0a4.post6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c08307fcba21e671d4a046e558b6b2d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 125140,
"upload_time": "2022-06-28T08:36:23",
"upload_time_iso_8601": "2022-06-28T08:36:23.418184Z",
"url": "https://files.pythonhosted.org/packages/42/69/6294bc2ab990cf57d48c8b1b0a316336320e4184aa3b79b89b35ed0451f2/ws_spdx_tools-0.7.0a4.post6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-28 08:36:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "spdx",
"github_project": "tools-python",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"appveyor": true,
"tox": true,
"lcname": "ws-spdx-tools"
}
JSON
