README.md

MEx editor

Metadata editor web application.

project

The Metadata Exchange (MEx) project is committed to improve the retrieval of RKI research data and projects. How? By focusing on metadata: instead of providing the actual research data directly, the MEx metadata catalog captures descriptive information about research data and activities. On this basis, we want to make the data FAIR¹ so that it can be shared with others.

Via MEx, metadata will be made findable, accessible and shareable, as well as available for further research. The goal is to get an overview of what research data is available, understand its context, and know what needs to be considered for subsequent use.

RKI cooperated with D4L data4life gGmbH for a pilot phase where the vision of a FAIR metadata catalog was explored and concepts and prototypes were developed. The partnership has ended with the successful conclusion of the pilot phase.

After an internal launch, the metadata will also be made publicly available and thus be available to external researchers as well as the interested (professional) public to find research data from the RKI.

For further details, please consult our project page.

Contact
For more information, please feel free to email us at mex@rki.de.

Publisher of this document

Robert Koch-Institut
Nordufer 20
13353 Berlin
Germany

package

The mex-editor is a browser application that allows creating and editing rules to non-destructively manipulate metadata. This can be used to enrich data with manual input or insert new data from scratch.

license

This package is licensed under the MIT license. All other software components of the MEx project are open-sourced under the same license as well.

development

installation

• on unix, consider using pyenv https://github.com/pyenv/pyenv
  • get pyenv curl https://pyenv.run | bash
  • install 3.11 pyenv install 3.11
  • switch version pyenv global 3.11
  • run make install
• on windows, consider using pyenv-win https://pyenv-win.github.io/pyenv-win/
  • follow https://pyenv-win.github.io/pyenv-win/#quick-start
  • install 3.11 pyenv install 3.11
  • switch version pyenv global 3.11
  • run .\mex.bat install

linting and testing

• run all linters with pdm lint
• run only unit tests with pdm unit
• run unit and integration tests with pdm test
  • for integration tests you need a local mex-backend, neo4j and mex-editor

updating dependencies

• update boilerplate files with cruft update
• update global requirements in requirements.txt manually
• update git hooks with pre-commit autoupdate
• update package dependencies using pdm update-all
• update github actions in .github/workflows/*.yml manually

creating release

• run pdm release RULE to release a new version where RULE determines which part of the version to update and is one of major, minor, patch.

container workflow

• build image with make image
• run directly using docker make run
• start with docker compose make start

commands

• run pdm run {command} --help to print instructions
• run pdm run {command} --debug for interactive debugging

editor

• pdm run editor run starts the editor service

Footnotes

1. FAIR is referencing the so-called FAIR data principles – guidelines to make data Findable, Accessible, Interoperable and Reusable. ↩