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

Shims/transforms for biotoolsSchema-compatibale metadata : advice needed! #11

Open
joncison opened this issue Mar 16, 2020 · 1 comment
Labels
help wanted Need help with this!

Comments

@joncison
Copy link
Member

joncison commented Mar 16, 2020

Chaps (@hansioan @hmenager @matuskalas @bgruening @albangaignard) - please help.

I want to get the biotoolsSchema paper out of the door and the main outstanding thing is elegant handling of the serialisation formats:  
-  biotoolsSchema-compliant XML, JSON and YAML formats 
-  shims for interconverting these
-  validation against biotoolsSchema / biotoolsSchemaJ

... all of this also useful for ETP "ecosystem".

Until now (for purposes of XML support in bio.tools) I'd created shims as XSLT transforms, which worked fine.  But this gets unmanageable for any-to-any interconversion  of XML, JSON and YAML - especially as we might need JSON-LD, and perhaps other formats in future (codemeta, whatever).

So I figure the elegant solution is to write a single utility in python (biotoolsshim.py) for all our tool metadata shimming/transformation needs.  Now, from my newbie-python perspective this isn't looking too hard BUT a spanner in the works is the <Summary> and <Labels> elements in the XSD - these complicate what (I think) would otherwise be a fairly straightforward exercise.  I could program around it, but it seems daft to do so!

<Summary> and <Labels>  are purely "organisational" (do not appear in biotoolsSchemaJ as documented here), so I'm thinking to release biotoolsSchema 3.3.0 which drops these elements, paving the way for easier coding. 

PS. The XSD I think has mostly served its purpose, and expect in future to focus on the JSON schema variant (biotoolsSchemaJ).  

I'm writing to get your input on this - any thoughts or suggestions much appreciated!

Thanks a million  

@joncison
Copy link
Member Author

joncison commented May 19, 2020

Hi @hansioan cc @hmenager

biotoolsSchema 3.3.0 is now out and along with it the shims for format handling / serialisation in bio.tools:

I haven't triple-checked everything (will do tomorrow) but it's ready for testing.

Cheers!

PS. in future I think the focus should be on biotoolsSchemaJ + a utility for general-purpose file reformatting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Need help with this!
Projects
None yet
Development

No branches or pull requests

1 participant