mex-model 4.1.0__tar.gz

mex_model-4.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robert Koch-Institut
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mex_model-4.1.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: mex-model
+Version: 4.1.0
+Summary: JSON schema files defining the MEx metadata model.
+Author-Email: MEx Team <mex@rki.de>
+License: MIT License
+         
+         Copyright (c) 2025 Robert Koch-Institut
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Project-URL: Repository, https://github.com/robert-koch-institut/mex-model
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: ipdb; extra == "dev"
+Requires-Dist: mypy<2; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: sphinx-jsonschema; extra == "dev"
+Requires-Dist: sphinx<9; extra == "dev"
+Description-Content-Type: text/markdown
+
+# MEx model
+
+JSON schema files defining the MEx metadata model.
+
+[![cookiecutter](https://github.com/robert-koch-institut/mex-model/actions/workflows/cookiecutter.yml/badge.svg)](https://github.com/robert-koch-institut/mex-template)
+[![cve-scan](https://github.com/robert-koch-institut/mex-model/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-model/actions/workflows/cve-scan.yml)
+[![documentation](https://github.com/robert-koch-institut/mex-model/actions/workflows/documentation.yml/badge.svg)](https://robert-koch-institut.github.io/mex-model)
+[![linting](https://github.com/robert-koch-institut/mex-model/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-model/actions/workflows/linting.yml)
+[![open-code](https://github.com/robert-koch-institut/mex-model/actions/workflows/open-code.yml/badge.svg)](https://gitlab.opencode.de/robert-koch-institut/mex/mex-model)
+
+## 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[^1] 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](https://www.rki.de/DE/Aktuelles/Publikationen/Forschungsdaten/MEx/metadata-exchange-plattform-mex-node.html).
+
+[^1]: FAIR is referencing the so-called
+[FAIR data principles](https://www.go-fair.org/fair-principles/) – guidelines to make
+data Findable, Accessible, Interoperable and Reusable.
+
+**Contact** \
+For more information, please feel free to email us at [mex@rki.de](mailto:mex@rki.de).
+
+### Publisher
+
+**Robert Koch-Institut** \
+Nordufer 20 \
+13353 Berlin \
+Germany
+
+## Package
+
+Our metadata model is represented as JSON schema in `mex/model`. There, we defined 1.
+`entities`, described by their properties, 2. `fields`, small objects, that are used as
+`$ref` for certain properties, 3. an `extension`, which contains additional properties,
+that are not in scope of the JSON schema definition, 4. `i18n` files, that hold
+translations of the properties and are to be used in the context of user interfaces and
+5. `vocabularies`, which are used in context of the `entities`. A more detailed
+description of the model's context can be found in `/docs/index.rst`.
+
+## License
+
+This package is licensed under the [MIT license](/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`
+
+### 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`.

mex_model-4.1.0/README.md

@@ -0,0 +1,93 @@
+# MEx model
+
+JSON schema files defining the MEx metadata model.
+
+[![cookiecutter](https://github.com/robert-koch-institut/mex-model/actions/workflows/cookiecutter.yml/badge.svg)](https://github.com/robert-koch-institut/mex-template)
+[![cve-scan](https://github.com/robert-koch-institut/mex-model/actions/workflows/cve-scan.yml/badge.svg)](https://github.com/robert-koch-institut/mex-model/actions/workflows/cve-scan.yml)
+[![documentation](https://github.com/robert-koch-institut/mex-model/actions/workflows/documentation.yml/badge.svg)](https://robert-koch-institut.github.io/mex-model)
+[![linting](https://github.com/robert-koch-institut/mex-model/actions/workflows/linting.yml/badge.svg)](https://github.com/robert-koch-institut/mex-model/actions/workflows/linting.yml)
+[![open-code](https://github.com/robert-koch-institut/mex-model/actions/workflows/open-code.yml/badge.svg)](https://gitlab.opencode.de/robert-koch-institut/mex/mex-model)
+
+## 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[^1] 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](https://www.rki.de/DE/Aktuelles/Publikationen/Forschungsdaten/MEx/metadata-exchange-plattform-mex-node.html).
+
+[^1]: FAIR is referencing the so-called
+[FAIR data principles](https://www.go-fair.org/fair-principles/) – guidelines to make
+data Findable, Accessible, Interoperable and Reusable.
+
+**Contact** \
+For more information, please feel free to email us at [mex@rki.de](mailto:mex@rki.de).
+
+### Publisher
+
+**Robert Koch-Institut** \
+Nordufer 20 \
+13353 Berlin \
+Germany
+
+## Package
+
+Our metadata model is represented as JSON schema in `mex/model`. There, we defined 1.
+`entities`, described by their properties, 2. `fields`, small objects, that are used as
+`$ref` for certain properties, 3. an `extension`, which contains additional properties,
+that are not in scope of the JSON schema definition, 4. `i18n` files, that hold
+translations of the properties and are to be used in the context of user interfaces and
+5. `vocabularies`, which are used in context of the `entities`. A more detailed
+description of the model's context can be found in `/docs/index.rst`.
+
+## License
+
+This package is licensed under the [MIT license](/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`
+
+### 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`.

mex_model-4.1.0/mex/__init__.py

@@ -0,0 +1,3 @@
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)

mex_model-4.1.0/mex/model/__init__.py

@@ -0,0 +1,22 @@
+import json
+from importlib.resources import files
+
+__all__ = (
+    "ENTITY_JSON_BY_NAME",
+    "FIELD_JSON_BY_NAME",
+    "VOCABULARY_JSON_BY_NAME",
+)
+
+ENTITY_JSON_BY_NAME = {
+    f.name.replace("-", "_").replace(".json", ""): json.loads(f.read_text("utf-8"))
+    for f in list(files("mex.model.entities").iterdir())
+    if not f.name.startswith("concept")
+}
+FIELD_JSON_BY_NAME = {
+    f.name.replace("-", "_").replace(".json", ""): json.loads(f.read_text("utf-8"))
+    for f in list(files("mex.model.fields").iterdir())
+}
+VOCABULARY_JSON_BY_NAME = {
+    f.name.replace("-", "_").replace(".json", ""): json.loads(f.read_text("utf-8"))
+    for f in list(files("mex.model.vocabularies").iterdir())
+}

mex_model-4.1.0/mex/model/entities/access-platform.json

@@ -0,0 +1,185 @@
+{
+    "$$target": "/schema/entities/access-platform#/identifier",
+    "$id": "https://mex.rki.de/schema/entities/access-platform",
+    "$schema": "http://json-schema.org/draft/2020-12/schema",
+    "description": "A technical system or service that provides access to distributions or resources.",
+    "properties": {
+        "alternativeTitle": {
+            "default": [],
+            "description": "An alternative name for the access platform.",
+            "items": {
+                "$ref": "/schema/fields/text"
+            },
+            "sameAs": [
+                "http://purl.org/dc/terms/alternative"
+            ],
+            "type": "array"
+        },
+        "contact": {
+            "default": [],
+            "description": "An agent that serves as a contact for the access platform.",
+            "items": {
+                "anyOf": [
+                    {
+                        "$ref": "/schema/entities/organizational-unit#/identifier"
+                    },
+                    {
+                        "$ref": "/schema/entities/person#/identifier"
+                    },
+                    {
+                        "$ref": "/schema/entities/contact-point#/identifier"
+                    }
+                ]
+            },
+            "sameAs": [
+                "http://www.w3.org/ns/dcat#contactPoint"
+            ],
+            "type": "array"
+        },
+        "description": {
+            "default": [],
+            "description": "A short description of the access platform.",
+            "items": {
+                "$ref": "/schema/fields/text"
+            },
+            "sameAs": [
+                "http://purl.org/dc/terms/description"
+            ],
+            "type": "array"
+        },
+        "endpointDescription": {
+            "anyOf": [
+                {
+                    "$ref": "/schema/fields/link"
+                },
+                {
+                    "type": "null"
+                }
+            ],
+            "default": null,
+            "description": "A description of the services available via the end-points, including their operations, parameters etc.",
+            "sameAs": [
+                "http://www.w3.org/ns/dcat#endpointDescription"
+            ]
+        },
+        "endpointType": {
+            "anyOf": [
+                {
+                    "$ref": "/schema/entities/concept#/identifier",
+                    "examples": [
+                        "https://mex.rki.de/item/api-type-1"
+                    ],
+                    "useScheme": "https://mex.rki.de/item/api-type"
+                },
+                {
+                    "type": "null"
+                }
+            ],
+            "default": null,
+            "description": "The type of endpoint, e.g. REST.",
+            "subPropertyOf": [
+                "http://purl.org/dc/terms/type"
+            ]
+        },
+        "endpointURL": {
+            "anyOf": [
+                {
+                    "$ref": "/schema/fields/link"
+                },
+                {
+                    "type": "null"
+                }
+            ],
+            "default": null,
+            "description": "The root location or primary endpoint of the service (a Web-resolvable IRI)",
+            "sameAs": [
+                "http://www.w3.org/ns/dcat#endpointURL"
+            ]
+        },
+        "hadPrimarySource": {
+            "$ref": "/schema/entities/primary-source#/identifier",
+            "description": "A primary source for a topic refers to something produced by some agent with direct experience and knowledge about the topic, at the time of the topic's study, without benefit from hindsight. Because of the directness of primary sources, they 'speak for themselves' in ways that cannot be captured through the filter of secondary sources. As such, it is important for secondary sources to reference those primary sources from which they were derived, so that their reliability can be investigated. A primary source relation is a particular case of derivation of secondary materials from their primary sources. It is recognized that the determination of primary sources can be up to interpretation, and should be done according to conventions accepted within the application's domain ([PROV-O, 2013-04-30 ](http://www.w3.org/TR/2013/REC-prov-o-20130430/)).",
+            "sameAs": [
+                "http://www.w3.org/ns/prov#hadPrimarySource"
+            ]
+        },
+        "identifier": {
+            "$ref": "/schema/fields/identifier",
+            "description": "An unambiguous reference to the resource within a given context. Persistent identifiers should be provided as HTTP URIs ([DCT, 2020-01-20](http://dublincore.org/specifications/dublin-core/dcmi-terms/2020-01-20/)).",
+            "sameAs": [
+                "http://purl.org/dc/elements/1.1/identifier"
+            ]
+        },
+        "identifierInPrimarySource": {
+            "description": "The identifier of the item used in the primary source.",
+            "examples": [
+                "123456",
+                "item-501",
+                "D7/x4/zz.final3"
+            ],
+            "maxLength": 1000,
+            "minLength": 1,
+            "pattern": "^[^\\n\\r]+$",
+            "type": "string"
+        },
+        "landingPage": {
+            "default": [],
+            "description": "A Web page that can be navigated to in a Web browser to gain access to the catalog, a dataset, its distributions and/or additional information.",
+            "items": {
+                "$ref": "/schema/fields/link"
+            },
+            "sameAs": [
+                "http://www.w3.org/ns/dcat#landingPage"
+            ],
+            "type": "array"
+        },
+        "stableTargetId": {
+            "$ref": "/schema/fields/identifier"
+        },
+        "technicalAccessibility": {
+            "$ref": "/schema/entities/concept#/identifier",
+            "description": "Indicates form if the platform can be accessed only within RKI network (internally) or if the platform is accessible publicly (externally).",
+            "examples": [
+                "https://mex.rki.de/item/technical-accessibility-1"
+            ],
+            "subPropertyOf": [
+                "http://purl.org/dc/terms/type"
+            ],
+            "useScheme": "https://mex.rki.de/item/technical-accessibility"
+        },
+        "title": {
+            "default": [],
+            "description": "The name of the access platform.",
+            "items": {
+                "$ref": "/schema/fields/text"
+            },
+            "sameAs": [
+                "http://purl.org/dc/terms/title"
+            ],
+            "type": "array"
+        },
+        "unitInCharge": {
+            "default": [],
+            "description": "This property refers to agents who assume responsibility and accountability for the resource and its appropriate maintenance.",
+            "items": {
+                "$ref": "/schema/entities/organizational-unit#/identifier"
+            },
+            "sameAs": [
+                "http://dcat-ap.de/def/dcatde/maintainer"
+            ],
+            "type": "array"
+        }
+    },
+    "required": [
+        "hadPrimarySource",
+        "identifier",
+        "identifierInPrimarySource",
+        "stableTargetId",
+        "technicalAccessibility"
+    ],
+    "sameAs": [
+        "http://www.w3.org/ns/dcat#DataService"
+    ],
+    "title": "Access Platform",
+    "type": "object"
+}