ROCrate-Converter (also for .eln-files)
Summary
This MR adds:
- ELNFileConverter
- ROCrateConverter
- ROCrateEntityConverter
So .eln files and their contents can be crawled, including traversal of hasPart
and integrated files.
This MR includes a set of tests for the new functionality.
Open points:
- How to handle the dependency to a patched version of ro-crate-py
- Use my fork: https://github.com/salexan2001/ro-crate-py/tree/f-automatic-dummy-ids ?
- Clean solution would be to fix the .eln files: https://github.com/TheELNConsortium/TheELNFileFormat/issues/89
- User Documentation -> https://gitlab.indiscale.com/caosdb/customers/f-fit/management/-/issues/50
-
Integration or system tests, testing the scanner or complete crawler runs.
Test Environment
There are tests provided.
Check List for the Author
Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines
-
All automated tests pass -
Reference related issues -
Up-to-date CHANGELOG.md (or not necessary) -
Up-to-date JSON schema (or not necessary) -
Appropriate user and developer documentation (or not necessary) - How do I use the software? Assume "stupid" users.
- How do I develop or debug the software? Assume novice developers.
-
Annotations in code (Gitlab comments) - Intent of new code
- Problems with old code
- Why this implementation?
Check List for the Reviewer
-
I understand the intent of this MR -
All automated tests pass -
Up-to-date CHANGELOG.md (or not necessary) -
Appropriate user and developer documentation (or not necessary) -
The test environment setup works and the intended behavior is reproducible in the test environment -
In-code documentation and comments are up-to-date. -
Check: Are there specifications? Are they satisfied?
For further good practices have a look at our review guidelines.
Edited by Alexander Schlemmer