https://github.com/bamresearch/masterdata-checker

Python package used to check the correctness of a given Masterdata definitions file with respect to the entities already registered in the BAM Data Store.

https://github.com/bamresearch/masterdata-checker

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary

Keywords

bam-data-store django openbis research-data-management
Last synced: 6 months ago · JSON representation

Repository

Python package used to check the correctness of a given Masterdata definitions file with respect to the entities already registered in the BAM Data Store.

Basic Info
  • Host: GitHub
  • Owner: BAMresearch
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 876 KB
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Topics
bam-data-store django openbis research-data-management
Created about 1 year ago · Last pushed 8 months ago
Metadata Files
Readme

README.md

Masterdata Checker

The masterdata_checker is a Django app used to check the correctness of a given Masterdata definitions file with respect to the entities already registered in the BAM Data Store (as defined in the bam-masterdata package). In the app, you can: - Log in your openBIS instance. - Run checks of a local Masterdata Excel file. Note: only supported file formats are .xls and .xlsx - Revise the errors logs to correct mistakes in the original Masterdata file.

Development

If you want to develop locally this package, clone the project and enter in the workspace folder: sh git clone https://github.com/BAMresearch/masterdata-checker cd masterdata_checker

We recommend using uv for fast pip installation of the package. In this case, you can instead create a virtual environment by doing: sh uv venv source .venv/bin/activate

Install the package with the desired optional dependencies (specified in between brackets, e.g., [dev]) and in editable mode (with the added -e flag): sh uv pip install -e '.[dev]'

Launch the Django app

In order to launch the Django app, navigate to the masterdata_checker/ subfolder: sh cd masterdata_checker

And run: sh python manage.py runserver

This will run the Django app server: ```sh Performing system checks...

System check identified no issues (0 silenced). June 05, 2025 - 06:24:20 Django version 5.2.1, using settings 'checker.settings' Starting development server at http://127.0.0.1:8000/ Quit the server with CONTROL-C. ```

Simply click on the localhost address http://127.0.0.1:8000/ to launch the app.

Main contributors

| Name | E-mail | |------|------------| | Carlos Madariaga | carlos.madariaga@bam.de | | Dr. Jose M. Pizarro | jose.pizarro-blanco@bam.de | | Jörg Rädler | joerg.raedler@bam.de | | Dr. Angela Ariza | angela.ariza@bam.de |

Owner

  • Name: Bundesanstalt für Materialforschung und -prüfung
  • Login: BAMresearch
  • Kind: organization
  • Email: oss@bam.de
  • Location: Berlin/Germany

German Federal scientific research institute for materials testing and research

GitHub Events

Total
  • Create event: 10
  • Issues event: 9
  • Watch event: 2
  • Delete event: 8
  • Issue comment event: 2
  • Push event: 22
  • Public event: 1
  • Pull request review comment event: 7
  • Pull request review event: 5
  • Pull request event: 12
Last Year
  • Create event: 10
  • Issues event: 9
  • Watch event: 2
  • Delete event: 8
  • Issue comment event: 2
  • Push event: 22
  • Public event: 1
  • Pull request review comment event: 7
  • Pull request review event: 5
  • Pull request event: 12

Dependencies

pyproject.toml pypi
  • click *
  • openpyxl *
  • pandas *
  • pybis *
.github/workflows/actions.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • chartboost/ruff-action v1 composite