1
- Python SPDX Library to parse, validate and create SPDX documents
2
- ==========================
1
+ # Python SPDX Library to parse, validate and create SPDX documents
3
2
4
3
This library implements an SPDX tag/value and RDF parser, validator and handler in Python.
5
4
This is the result of an initial GSoC contribution by @ah450 https://github.com/ah450 and
@@ -12,28 +11,25 @@ Issues: https://github.com/spdx/tools-python/issues
12
11
Pypi: https://pypi.python.org/pypi/spdx-tools
13
12
14
13
15
- License:
16
- ========
14
+ # License
17
15
18
16
Apache-2.0
19
17
20
18
21
- Features:
22
- ==================
19
+ # Features
23
20
24
21
* API to create and manipulate SPDX documents.
25
22
* Parse and create Tag/Value format SPDX files
26
23
* Parse and create RDF format SPDX files
27
24
28
25
29
- TODOs:
30
- ======
26
+ # TODOs
31
27
32
28
* Update to full SPDX v2.1
33
29
* Add to full license expression support
34
30
35
- How to use:
36
- ===========
31
+
32
+ # How to use
37
33
38
34
Example tag/value parsing usage:
39
35
``` Python
@@ -68,30 +64,26 @@ The `examples` directory contains several code samples:
68
64
` python pp_rdf.py data/SPDXRdfExample.rdf pretty.rdf `
69
65
70
66
71
- Installation:
72
- =============
67
+ # Installation
73
68
74
69
Clone or download the repository and run ` python setup.py install ` . (In a virtualenv, of course)
75
70
76
71
or install from Pypi with ` pip install spdx-tools `
77
72
78
73
79
- How to run tests:
80
- =================
74
+ # How to run tests
81
75
82
76
From the project root directory run: ` python setup.py test ` .
83
77
You can use another test runner such as pytest or nose at your preference.
84
78
85
79
86
- Dependencies:
87
- =============
80
+ # Dependencies
88
81
89
82
* PLY : https://pypi.python.org/pypi/ply/ used for parsing.
90
83
* rdflib : https://pypi.python.org/pypi/rdflib/ for for handling RDF.
91
84
92
85
93
- Support:
94
- =======
86
+ # Support
95
87
96
88
* Submit issues, questions or feedback at: https://github.com/spdx/tools-python/issues
97
89
* Join the dicussion on https://lists.spdx.org/mailman/listinfo/spdx-tech and
0 commit comments