bam-masterdata 0.4.2__tar.gz → 0.5.0__tar.gz

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/.github/workflows/actions.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python_version: ["3.9", "3.10", "3.11", "3.12"]
+        python_version: ["3.10", "3.11", "3.12"]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{matrix.python_version}}
@@ -32,9 +32,9 @@ jobs:
       run: |
         pip install --upgrade pip
         uv pip install -e '.[dev]'
-    - name: mypy
-      run: |
-        python -m mypy --ignore-missing-imports --follow-imports=silent --no-strict-optional bam_masterdata tests
+    # - name: mypy
+    #   run: |
+    #     python -m mypy --ignore-missing-imports --follow-imports=silent --no-strict-optional bam_masterdata tests
     - name: Test with pytest
       run: |
         python -m pytest -sv --ignore=tests/cli --ignore=tests/metadata/test_entities_dict.py tests

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/.github/workflows/mkdocs-deploy.yml

@@ -14,10 +14,10 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-      - name: Set up Python 3.11
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: 3.12
       - name: Install Documentation Dependencies
         run: |
           pip install --upgrade pip

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/.github/workflows/publish.yml

@@ -23,10 +23,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.11
+    - name: Set up Python 3.12
       uses: actions/setup-python@v5
       with:
-        python-version: 3.11
+        python-version: 3.12
     - name: Install uv
       run: |
         curl -LsSf https://astral.sh/uv/install.sh | sh

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bam-masterdata
-Version: 0.4.2
+Version: 0.5.0
 Summary: The BAM Data Store utility tools and masterdata models wrapped in a Python package with a front-end web interface.
 Author-email: BAM Data Store <datastore@bam.de>
 Maintainer-email: "Jose M. Pizarro" <jose.pizarro-blanco@bam.de>
@@ -31,15 +31,15 @@ License: MIT License - MODIFIED
         done if you use parts of this datamodel in your own modelling.
 Project-URL: Homepage, https://github.com/BAMresearch/bam-masterdata
 Project-URL: Bug Tracker, https://github.com/BAMresearch/bam-masterdata/issues
+Project-URL: Documentation, https://bamresearch.github.io/bam-masterdata/
 Classifier: Natural Language :: English
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
@@ -49,14 +49,14 @@ Requires-Dist: click
 Requires-Dist: pydantic~=2.10.5
 Requires-Dist: rdflib
 Requires-Dist: h5py~=3.12.1
+Requires-Dist: python-decouple
+Requires-Dist: structlog==24.4.0
 Provides-Extra: dev
 Requires-Dist: mypy==1.0.1; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-timeout; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: python-decouple; extra == "dev"
-Requires-Dist: structlog==24.4.0; extra == "dev"
 Provides-Extra: docu
 Requires-Dist: mkdocs-material; extra == "docu"
 Requires-Dist: mkdocs-click; extra == "docu"
@@ -82,24 +82,19 @@ Dynamic: license-file
 
 </h4>
 
-The BAM Masterdata is a repository containing all the masterdata schema defining in BAM, as well as some utility functions to handle the masterdata.
+The BAM Masterdata repository contains the masterdata schemas defined at BAM and provides utility functions for working with them.
 
 If you want to install it, do:
 ```sh
 pip install bam-masterdata
 ```
 
-In order to include the CLI functionalities, you have to add the optional `[dev]` dependencies when pip installing the package:
-```sh
-pip install bam-masterdata[dev]
-```
-
 ## Development
 
 If you want to develop locally this package, clone the project and enter in the workspace folder:
 
 ```sh
-git clone https://git.bam.de/bam-data-store/bam-masterdata.git
+git clone https://github.com/BAMresearch/bam-masterdata.git
 cd bam-masterdata
 ```
 
@@ -110,11 +105,17 @@ python3 -m venv .venv
 source .venv/bin/activate
 ```
 
-Run the following script:
+Run the following script depending on your OS:
+- *Linux/MacOS*:
+  ```sh
+  ./scripts/install_python_dependencies.sh
+  ```
+- *Windows*:
+  ```sh
+  scripts/install_python_dependencies.bat
+  ```
 
-```sh
-./scripts/install_python_dependencies
-```
+**Note**: This script installs the required dependencies for development, testing, and documentation, using `uv` and `pip`.
 
 ### Run the tests
 
@@ -143,53 +144,22 @@ ruff check .
 This will produce an output with the specific issues found. In order to auto-fix them, run:
 
 ```sh
-ruff format . --check
+ruff format .
 ```
 
 If some issues are not possible to fix automatically, you will need to visit the file and fix them by hand.
 
-### Run the local website
-
-**Under construction!**
-
-<!-- ### Debugging
-
-For interactive debugging of the tests, use `pytest` with the `--pdb` flag. We recommend using an IDE for debugging, e.g., _VSCode_. If that is the case, add the following snippet to your `.vscode/launch.json`:
-```json
-{
-  "configurations": [
-      {
-        "name": "<descriptive tag>",
-        "type": "debugpy",
-        "request": "launch",
-        "cwd": "${workspaceFolder}",
-        "program": "${workspaceFolder}/.pyenv/bin/pytest",
-        "justMyCode": true,
-        "env": {
-            "_PYTEST_RAISE": "1"
-        },
-        "args": [
-            "-sv",
-            "--pdb",
-            "<path-to-plugin-tests>",
-        ]
-    }
-  ]
-}
-```
-
-where `<path-to-plugin-tests>` must be changed to the local path to the test module to be debugged.
-
-The settings configuration file `.vscode/settings.json` automatically applies the linting and formatting upon saving the modified file. -->
 
 ### Documentation on Github pages
 
-To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.sh`, so if you ran this script before, you don't need to do it again now):
+To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.*`, so if you ran this script before, you don't need to do it again now):
 
 ```sh
 uv pip install -e '[docu]'
 ```
 
+**Note**: This command installs `mkdocs`, `mkdocs-material`, and other documentation-related dependencies.
+
 The first time, build the server:
 
 ```sh

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/README.md

@@ -17,24 +17,19 @@
 
 </h4>
 
-The BAM Masterdata is a repository containing all the masterdata schema defining in BAM, as well as some utility functions to handle the masterdata.
+The BAM Masterdata repository contains the masterdata schemas defined at BAM and provides utility functions for working with them.
 
 If you want to install it, do:
 ```sh
 pip install bam-masterdata
 ```
 
-In order to include the CLI functionalities, you have to add the optional `[dev]` dependencies when pip installing the package:
-```sh
-pip install bam-masterdata[dev]
-```
-
 ## Development
 
 If you want to develop locally this package, clone the project and enter in the workspace folder:
 
 ```sh
-git clone https://git.bam.de/bam-data-store/bam-masterdata.git
+git clone https://github.com/BAMresearch/bam-masterdata.git
 cd bam-masterdata
 ```
 
@@ -45,11 +40,17 @@ python3 -m venv .venv
 source .venv/bin/activate
 ```
 
-Run the following script:
+Run the following script depending on your OS:
+- *Linux/MacOS*:
+  ```sh
+  ./scripts/install_python_dependencies.sh
+  ```
+- *Windows*:
+  ```sh
+  scripts/install_python_dependencies.bat
+  ```
 
-```sh
-./scripts/install_python_dependencies
-```
+**Note**: This script installs the required dependencies for development, testing, and documentation, using `uv` and `pip`.
 
 ### Run the tests
 
@@ -78,53 +79,22 @@ ruff check .
 This will produce an output with the specific issues found. In order to auto-fix them, run:
 
 ```sh
-ruff format . --check
+ruff format .
 ```
 
 If some issues are not possible to fix automatically, you will need to visit the file and fix them by hand.
 
-### Run the local website
-
-**Under construction!**
-
-<!-- ### Debugging
-
-For interactive debugging of the tests, use `pytest` with the `--pdb` flag. We recommend using an IDE for debugging, e.g., _VSCode_. If that is the case, add the following snippet to your `.vscode/launch.json`:
-```json
-{
-  "configurations": [
-      {
-        "name": "<descriptive tag>",
-        "type": "debugpy",
-        "request": "launch",
-        "cwd": "${workspaceFolder}",
-        "program": "${workspaceFolder}/.pyenv/bin/pytest",
-        "justMyCode": true,
-        "env": {
-            "_PYTEST_RAISE": "1"
-        },
-        "args": [
-            "-sv",
-            "--pdb",
-            "<path-to-plugin-tests>",
-        ]
-    }
-  ]
-}
-```
-
-where `<path-to-plugin-tests>` must be changed to the local path to the test module to be debugged.
-
-The settings configuration file `.vscode/settings.json` automatically applies the linting and formatting upon saving the modified file. -->
 
 ### Documentation on Github pages
 
-To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.sh`, so if you ran this script before, you don't need to do it again now):
+To view the documentation locally, make sure to have installed the extra packages (this is part of the `scripts/install_python_dependencies.*`, so if you ran this script before, you don't need to do it again now):
 
 ```sh
 uv pip install -e '[docu]'
 ```
 
+**Note**: This command installs `mkdocs`, `mkdocs-material`, and other documentation-related dependencies.
+
 The first time, build the server:
 
 ```sh
@@ -173,4 +143,4 @@ The main datamodel developers are:
 - Julien Lecompagnon
 - Jan Lisec
 - Mathias Röllig
-- Bastian Rühle
+- Bastian Rühle

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/bam_masterdata/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.2'
-__version_tuple__ = version_tuple = (0, 4, 2)
+__version__ = version = '0.5.0'
+__version_tuple__ = version_tuple = (0, 5, 0)

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/bam_masterdata/checker/masterdata_validator.py

@@ -180,7 +180,7 @@ class MasterdataValidator:
                 # Check if required properties exist in specific sections
                 required_properties = {
                     "Additional Information": "NOTES",
-                    "Comments": "COMMENTS",
+                    "Comments": "$XMLCOMMENTS",
                 }
 
                 # Track found properties
@@ -573,7 +573,7 @@ class MasterdataValidator:
                         if "code" in property_item:
                             codes.add(property_item["code"])
                 # Recursively check for more nested structures
-                elif isinstance(value, (dict, list)):
+                elif isinstance(value, dict | list):
                     codes.update(self.extract_property_codes(value))
 
         elif isinstance(data, list):

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/bam_masterdata/checker/source_loader.py

@@ -107,8 +107,8 @@ class SourceLoader:
                     transformed_entity["defs"]["generated_code_prefix"] = (
                         entity_data.get("generatedCodePrefix")
                     )
-                    transformed_entity["defs"]["auto_generated_codes"] = (
-                        entity_data.get("autoGeneratedCode")
+                    transformed_entity["defs"]["auto_generate_codes"] = entity_data.get(
+                        "autoGeneratedCode"
                     )
 
                 # Convert properties from dict to list

{bam_masterdata-0.4.2/bam_masterdata → bam_masterdata-0.5.0/bam_masterdata/checker}/validation_rules/all_validation_rules.json

@@ -1,76 +1,76 @@
-{
-  "code": {
-    "pattern": "^\\$?[A-Za-z0-9_.]+$"
-  },
-  "description": {
-    "pattern": ".*",
-    "is_description": true
-  },
-  "validation_script": {
-    "pattern": "^[A-Za-z0-9_\\.]+$",
-    "allow_empty": true
-  },
-  "auto_generated_codes": {
-    "is_bool": true
-  },
-  "main_dataset_pattern": {
-    "pattern": ".*",
-    "allow_empty": true
-  },
-  "main_dataset_path": {
-    "pattern": ".*",
-    "allow_empty": true
-  },
-  "property_label": {
-    "pattern": ".*"
-  },
-  "data_type": {
-    "is_data": true
-  },
-  "vocabulary_code": {
-    "pattern": "^\\$?[A-Za-z0-9_.]+$",
-    "allow_empty": true
-  },
-  "object_code": {
-    "pattern": "^\\$?[A-Za-z0-9_.]+$",
-    "allow_empty": true
-  },
-  "metadata": {
-    "pattern": ".*",
-    "allow_empty": true
-  },
-  "url_template": {
-    "pattern": "https?://(?:www\\.)?[a-zA-Z0-9-._~:/?#@!$&'()*+,;=%]+",
-    "is_url": true,
-    "allow_empty": true
-  },
-  "dynamic_script": {
-    "pattern": "^[A-Za-z0-9_\\.]+$",
-    "allow_empty": true
-  },
-  "mandatory": {
-    "is_bool": true
-  },
-  "show_in_edit_views": {
-    "is_bool": true
-  },
-  "section": {
-    "pattern": ".*"
-  },
-  "unique": {
-    "is_bool": true,
-    "allow_empty": true
-  },
-  "internal_assignment": {
-    "pattern": ".*",
-    "allow_empty": true
-  },
-  "generated_code_prefix": {
-    "pattern": ".*",
-    "extra_validation": "is_reduced_version"
-  },
-  "official": {
-    "is_bool": true,
-    "allow_empty": true
-  }
+{
+  "code": {
+    "pattern": "^\\$?[A-Za-z0-9_.]+$"
+  },
+  "description": {
+    "pattern": ".*",
+    "is_description": true
+  },
+  "validation_script": {
+    "pattern": "^[A-Za-z0-9_\\.]+$",
+    "allow_empty": true
+  },
+  "auto_generate_codes": {
+    "is_bool": true
+  },
+  "main_dataset_pattern": {
+    "pattern": ".*",
+    "allow_empty": true
+  },
+  "main_dataset_path": {
+    "pattern": ".*",
+    "allow_empty": true
+  },
+  "property_label": {
+    "pattern": ".*"
+  },
+  "data_type": {
+    "is_data": true
+  },
+  "vocabulary_code": {
+    "pattern": "^\\$?[A-Za-z0-9_.]+$",
+    "allow_empty": true
+  },
+  "object_code": {
+    "pattern": "^\\$?[A-Za-z0-9_.]+$",
+    "allow_empty": true
+  },
+  "metadata": {
+    "pattern": ".*",
+    "allow_empty": true
+  },
+  "url_template": {
+    "pattern": "https?://(?:www\\.)?[a-zA-Z0-9-._~:/?#@!$&'()*+,;=%]+",
+    "is_url": true,
+    "allow_empty": true
+  },
+  "dynamic_script": {
+    "pattern": "^[A-Za-z0-9_\\.]+$",
+    "allow_empty": true
+  },
+  "mandatory": {
+    "is_bool": true
+  },
+  "show_in_edit_views": {
+    "is_bool": true
+  },
+  "section": {
+    "pattern": ".*"
+  },
+  "unique": {
+    "is_bool": true,
+    "allow_empty": true
+  },
+  "internal_assignment": {
+    "pattern": ".*",
+    "allow_empty": true
+  },
+  "generated_code_prefix": {
+    "pattern": ".*",
+    "extra_validation": "is_reduced_version"
+  },
+  "official": {
+    "is_bool": true,
+    "allow_empty": true
+  }
 }

{bam_masterdata-0.4.2 → bam_masterdata-0.5.0}/bam_masterdata/checker/validation_rules/excel_validation_rules.json

@@ -12,7 +12,7 @@
       "pattern": ".*",
       "extra_validation": "is_reduced_version"
     },
-    "Auto generated codes": {"key": "autoGeneratedCode", "pattern": null, "is_bool": true}
+    "Auto generate codes": {"key": "autoGeneratedCode", "pattern": null, "is_bool": true}
   },
   "OBJECT_TYPE": {
     "Code": {"key": "code", "pattern": "^\\$?[A-Za-z0-9_.-]+$"},
@@ -27,7 +27,7 @@
       "pattern": ".*",
       "extra_validation": "is_reduced_version"
     },
-    "Auto generated codes": {"key": "autoGeneratedCode", "pattern": null, "is_bool": true}
+    "Auto generate codes": {"key": "autoGeneratedCode", "pattern": null, "is_bool": true}
   },
   "EXPERIMENT_TYPE": {
     "Code": {"key": "code", "pattern": "^\\$?[A-Za-z0-9_.-]+$"},