Skip to content

Add JSON, YAML and XML writing and parsing support #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 23 commits into from
Aug 28, 2019
Merged

Add JSON, YAML and XML writing and parsing support #96

merged 23 commits into from
Aug 28, 2019

Conversation

xavierfigueroav
Copy link
Collaborator

@xavierfigueroav xavierfigueroav commented Apr 5, 2019 •
edited
Loading

  1. Add JSON, YAML and XML writers (json.py, yaml.py and xml.py in spdx/writers/)
  2. Add JSON, YAML and XML parsers and builders (jsonyamlxml.py and jsonyamlxmlbuilders.py in spdx/parsers/)

Signed-off-by: Xavier Figueroa xavierfigueroav@gmail.com

@xavierfigueroav xavierfigueroav changed the title Add JSON and YAML writing and parsing support Add YAML writing and parsing support Apr 5, 2019
pombredanne
pombredanne reviewed Apr 8, 2019
View reviewed changes
setup.py Outdated
@@ -24,6 +24,7 @@ def test_suite():
'ply',
'rdflib',
'six',
'ruamel.yaml',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not use that YAML parser: it requires a native and a C compiler. Use PyYaml instead

pombredanne
pombredanne requested changes Apr 8, 2019
View reviewed changes
Copy link
Member

@pombredanne pombredanne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. I think you are missing some tests?

krysnuvadga
krysnuvadga reviewed Apr 15, 2019
View reviewed changes
Copy link
Collaborator

@krysnuvadga krysnuvadga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just by having a quick glance, you might want to add support py3

@xavierfigueroav
Copy link
Collaborator Author

xavierfigueroav commented Apr 15, 2019 •
edited
Loading

Just by having a quick glance, you might want to add support py3

@krysnuvadga You mean the example files only, right?

@xavierfigueroav
Copy link
Collaborator Author

@pombredanne @pombredanne I've made the changes requested. Please, let me know if something is wrong or missing

@pombredanne pombredanne changed the title Add YAML writing and parsing support Add YAML and JSON writing and parsing May 31, 2019
@xavierfigueroav xavierfigueroav changed the title Add YAML and JSON writing and parsing Add JSON, YAML and XML writing and parsing support Jun 21, 2019
@xavierfigueroav xavierfigueroav force-pushed the master branch 3 times, most recently from 4890ed7 to 23dfe4b Compare August 23, 2019 02:08
@xavierfigueroav
Add JSON documents creating capability.
a3dcde9 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add YAML documents creating capability.
d4bfe2f 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add examples that convert from RDF and tag/value formats to JSON and …
b53e5c7 
…YAML.

Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add JSON/YAML documents building and parsing capabilities.
86bc02f 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add JSON/YAML builders and parsers documentation.
255cfe0 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add JSON/YAML parsing usage examples.
a295cf9 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Replace ruamel.yaml by PyYAML as a dependency for handling YAML format.
ac6ed5d 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add tests for JSON and YAML capabilities.
096dacf 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Update examples to Python 3 syntax.
135548e 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Use ExtractedLicense objects in other types of licenses which contain…
8bab698 
… them.

Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Change write test files to support new license formats:
bd94ced 
- '-or-later' instead of '+'
- '-only' instead of nothing

Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add support for parsing and creating Snippet information.
88c537e 
Modify tests to support Snippet information.

Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add XML documents parsing and creating capabilities.
b70ada3 
Add library 'xmltodict' as dependency in setup.py file.
Change the name of base writers, parsers and builders to indicate the XML support.

Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add tests for XML parsers and writers.
0d062c1 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add XML capabilities usage examples.
826ce79 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Add support for parsing and writing package identifier to JSON/YAML/X…
a621030 
…ML formats.

Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Improve JSON, YAML and XML capabilities documentation.
a330b05 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Update README.md to include JSON/YAML/XML capabilities.
2840266 
Signed-off-by: Xavier Figueroa <xavierfigueroav@gmail.com>
@xavierfigueroav
Copy link
Collaborator Author

@pombredanne this is ready for review. Please check!

@pombredanne
Copy link
Member

@xavierfigueroav thank you!

@pombredanne
Use context manager to open/close files safely
19dbedc 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Do not use builtin "file" as a variable name
79217e3 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Cleanup code
968c62e 
Add missing notices
Organize and sorts imports
Import proper __future__

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Copy link
Member

I pushed a few cleanup commits. Please review

@xavierfigueroav
Copy link
Collaborator Author

@pombredanne Everything looks great!

@pombredanne
Add maxDiff None to all tests and format code
a1c67b3 
Also remove __main__ from test code

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Format source code
cee204f 
This is mostly trimming extra white spaces.

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne pombredanne merged commit cee204f into spdx:master Aug 28, 2019
@pombredanne
Copy link
Member

All merged now. Thank you ++

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@krysnuvadga krysnuvadga krysnuvadga left review comments

@pombredanne pombredanne pombredanne requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xavierfigueroav @pombredanne @krysnuvadga