Skip to content

Commit e1e5485

Browse files
committed
Updates README
Signed-off-by: Ahmed H. Ismail <ahm3d.hisham@gmail.com>
1 parent bae0f80 commit e1e5485

2 files changed

Lines changed: 54 additions & 2 deletions

File tree

README

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,36 @@ Official repository: http://git.spdx.org/?p=spdx-tools-python.git
55

66
GitHub mirror: https://github.com/ah450/sdpx-tools-python
77

8+
This library provides an implementation of a tag/value and RDF SPDX parser in python.
9+
10+
Expected Features:
11+
==================
12+
* API for creating and manipulating SPDX documents.
13+
* Parse Tag/Value format SPDX files
14+
* Parse RDF format SPDX files
15+
* Create Tag/Value files.
16+
* Create RDF files.
17+
18+
19+
Current Status:
20+
===============
21+
* RDF Parser unimplemented.
22+
* Tag/Value Parser missing License parsing rules.
23+
* Writers unimplemented.
824

925
How to use:
1026
===========
11-
Coming soon.
27+
28+
Sample Tag/Value parsing Usage:
29+
30+
from spdx.parsers.tagvalue import Parser
31+
from spdx.parsers.tagvaluebuilders import Builder
32+
from spdx.parsers.loggers import StandardLogger
33+
p = Parser(Builder(), StandardLogger())
34+
p.build()
35+
# data is a string containing the SPDX file.
36+
document, error = p.parse(data)
37+
1238

1339

1440

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,36 @@ Official repository: http://git.spdx.org/?p=spdx-tools-python.git
55

66
GitHub mirror: https://github.com/ah450/sdpx-tools-python
77

8+
This library provides an implementation of a tag/value and RDF SPDX parser in python.
9+
10+
Expected Features:
11+
==================
12+
* API for creating and manipulating SPDX documents.
13+
* Parse Tag/Value format SPDX files
14+
* Parse RDF format SPDX files
15+
* Create Tag/Value files.
16+
* Create RDF files.
17+
18+
Current Status:
19+
===============
20+
* RDF Parser unimplemented.
21+
* Tag/Value Parser missing License parsing rules.
22+
* Writers unimplemented.
23+
824

925
How to use:
1026
===========
11-
Coming soon.
27+
Sample Tag/Value parsing Usage:
28+
```Python
29+
from spdx.parsers.tagvalue import Parser
30+
from spdx.parsers.tagvaluebuilders import Builder
31+
from spdx.parsers.loggers import StandardLogger
32+
p = Parser(Builder(), StandardLogger())
33+
p.build()
34+
# data is a string containing the SPDX file.
35+
document, error = p.parse(data)
36+
37+
```
1238

1339
How to run tests:
1440
=================

0 commit comments

Comments
 (0)