https://github.com/rdmorganiser/rdmo-plugins-somef
RDMO Project Import plugin for SMPs using SOMEF
https://github.com/rdmorganiser/rdmo-plugins-somef
data-management-plan metadata-extraction
Last synced: 10 months ago
JSON representation
RDMO Project Import plugin for SMPs using SOMEF
- Host: GitHub
- URL: https://github.com/rdmorganiser/rdmo-plugins-somef
- Owner: rdmorganiser
- License: apache-2.0
- Created: 2023-11-28T14:16:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-10T09:53:08.000Z (over 1 year ago)
- Last Synced: 2025-09-04T19:45:54.060Z (10 months ago)
- Topics: data-management-plan, metadata-extraction
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# RDMO Plugin SOMEF
This plugin imports extracted metadata from the [SOMEF](https://github.com/KnowledgeCaptureAndDiscovery/somef) into RDMO for the SMP catalogue. It can be used for the automated transfer of information in GitHub repositories to RDMO.
## Setup
Install the plugin in your RDMO virtual environment using pip (directly from GitHub):
```bash
pip install git+https://github.com/rdmorganiser/rdmo-plugins-somef.git
```
The dependency [`tomli`](https://pypi.org/project/tomli/) will be installed automatically.
### Configuration of rdmo in the rdmo-app
Add the `rdmo_plugins_somef` app to your `INSTALLED_APPS` in `config/settings/local.py``:
```py
from . import INSTALLED_APPS
INSTALLED_APPS = ['rdmo_plugins_somef'] + INSTALLED_APPS
```
Add the export plugins to the PROJECT_IMPORTS in config/settings/local.py:
```py
from django.utils.translation import gettext_lazy as _
from . import PROJECT_IMPORTS
PROJECT_IMPORTS += [
('somef', _('as somef JSON'), 'rdmo_plugins_somef.imports.somef.SomefImport')
]
```
### Local installation of somef in separate python env
The dependency [`somef`](https://pypi.org/project/somef/) will be installed in a separate environment from rdmo and executed by rdmo via a script with a `subprocess` function call. For the setup of the local `somef` environment an installation of `python 3.9` needs to be present. Please use the following commands to set up the enviroment.
```bash
chmod +x rdmo_plugins_somef/imports/scripts/create_somef_env.sh
./rdmo_plugins_somef/imports/scripts/create_somef_env.sh
# please enable execution of the somef call script as well
chmod +x rdmo_plugins_somef/imports/scripts/somef_describe.sh
```
The local installation of `somef` can be tested with:
```bash
source rdmo_plugins_somef/imports/scripts/env/bin/activate
somef describe -r https://github.com/dgarijo/Widoco/ -o test.json -t 0.8
somef describe -r https://github.com/rdmorganiser/rdmo -o test.json -t 0.8
```
## Acknowledgements
This plugin `rdmo-plugins-somef`, was created during the maSMP hackathon at [ZB MED](https://www.zbmed.de/en/) sponsored by [NFDI4DataScience](https://www.nfdi4datascience.de/). [NFDI4DataScience](https://www.nfdi4datascience.de/) is a consortium funded by the German Research Foundation (DFG), project number 460234259.