Skip to content
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.

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

Provide a non-RDFa RDF Readable format for license files on spdx.org/licenses #146

Closed
goneall opened this issue Jan 10, 2018 · 4 comments
Closed
Assignees
Milestone

Comments

@goneall
Copy link
Member

goneall commented Jan 10, 2018

To resolve issue #90 and help with issue #145, I would like to remove the RDFa dependency from the SPDX tools.

RDFa is currently used to read the license information from spdx.org/licenses.

An additional format could be added to the website which is machine readable and more efficiently parsed by the tools.

There are several formats to choose from:

  1. RDF/XML
  2. JSON-LD with contexts embedded in the JSON files as separate files from the current .json files
  3. JSON-LD by adding contexts to the current JSON files
  4. JSON-LD by adding a reference to an context file
  5. RDF Turtle
  6. Some other RDF format
  7. any permutation of the above choices

I'm leaning towards 3 as long as it doesn't break compatibility with existing uses of JSON files. Option 4 would be cleaner and more compact, but would require the SPDX tools always be connected to the internet to run.

@kemitchell @yevster @wking thoughts?

@wking
Copy link
Contributor

wking commented Jan 10, 2018 via email

@goneall
Copy link
Member Author

goneall commented Jan 10, 2018

Option 4 would not require an internet connection if you use a relative URI for the @Schema value.

Good point, in which case option 4 would be a better approach IMHO

@goneall goneall self-assigned this Apr 9, 2018
@goneall goneall added this to the 2.1.12 milestone Apr 9, 2018
@goneall
Copy link
Member Author

goneall commented Apr 10, 2018

Having a difficult time convincing the Jena library to use an external context file, so decided to go with option number 3 for now. Since we are using a library that reads both internal and external contexts, the SPDX tools code is the same for option 3 and 4. We can update the LicenseListPublisher in the future to generate files with an external context.

goneall added a commit that referenced this issue Apr 12, 2018
…DFa. Fixes issue #90, issue #146 and issue #145

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
goneall added a commit that referenced this issue Apr 14, 2018
…DFa (#158)

* Read standard licenses in JSON-LD format and remove dependencies on RDFa.  Fixes issue #90, issue #146 and issue #145

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

* Update URL for listed licenses to the released license list

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

* Fix unit test failures - cached listed license was being modified.  Resolved by cloning the returned license from get license by ID

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

* Update the path the license list to the released license list files

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
@goneall
Copy link
Member Author

goneall commented Apr 14, 2018

Resolved in version 2.1.12 - I'll revisit the external context in the 3.0 timeframe

@goneall goneall closed this as completed Apr 14, 2018
goneall added a commit that referenced this issue Apr 26, 2020
…DFa (#158)

* Read standard licenses in JSON-LD format and remove dependencies on RDFa.  Fixes issue #90, issue #146 and issue #145

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

* Update URL for listed licenses to the released license list

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

* Fix unit test failures - cached listed license was being modified.  Resolved by cloning the returned license from get license by ID

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>

* Update the path the license list to the released license list files

Signed-off-by: Gary O'Neall <gary@sourceauditor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants