dapla-toolbelt-metadata 0.4.2__tar.gz → 0.5.0__tar.gz

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

@@ -1,16 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: dapla-toolbelt-metadata
-Version: 0.4.2
+Version: 0.5.0
 Summary: Dapla Toolbelt Metadata
-Home-page: https://github.com/statisticsnorway/dapla-toolbelt-metadata
 License: MIT
 Author: Team Metadata
 Author-email: metadata@ssb.no
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.11,<4.0
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -24,11 +22,13 @@ Requires-Dist: pydantic (>=2.5.2)
 Requires-Dist: pyjwt (>=2.8.0)
 Requires-Dist: python-dotenv (>=1.0.1)
 Requires-Dist: requests (>=2.31.0)
+Requires-Dist: ruamel-yaml (>=0.18.10,<0.19.0)
 Requires-Dist: ssb-datadoc-model (>=6.0.0,<7.0.0)
 Requires-Dist: ssb-klass-python (>=0.0.9)
 Requires-Dist: typing-extensions (>=4.12.2)
 Project-URL: Changelog, https://github.com/statisticsnorway/dapla-toolbelt-metadata/releases
 Project-URL: Documentation, https://statisticsnorway.github.io/dapla-toolbelt-metadata
+Project-URL: Homepage, https://github.com/statisticsnorway/dapla-toolbelt-metadata
 Project-URL: Repository, https://github.com/statisticsnorway/dapla-toolbelt-metadata
 Description-Content-Type: text/markdown
 
@@ -45,7 +45,6 @@ Description-Content-Type: text/markdown
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_dapla-toolbelt-metadata&metric=alert_status&token=ee0a4d273db2bf811222fca5dffccd4592e3d536)][sonarquality]
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
-[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]
 
@@ -56,7 +55,6 @@ Description-Content-Type: text/markdown
 [sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_dapla-toolbelt-metadata
 [sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_dapla-toolbelt-metadata
 [pre-commit]: https://github.com/pre-commit/pre-commit
-[black]: https://github.com/psf/black
 [poetry]: https://python-poetry.org/
 
 Tools and clients for working with the Dapla Metadata system.

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

@@ -11,7 +11,6 @@
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=statisticsnorway_dapla-toolbelt-metadata&metric=alert_status&token=ee0a4d273db2bf811222fca5dffccd4592e3d536)][sonarquality]
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
-[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)][poetry]
 
@@ -22,7 +21,6 @@
 [sonarcov]: https://sonarcloud.io/summary/overall?id=statisticsnorway_dapla-toolbelt-metadata
 [sonarquality]: https://sonarcloud.io/summary/overall?id=statisticsnorway_dapla-toolbelt-metadata
 [pre-commit]: https://github.com/pre-commit/pre-commit
-[black]: https://github.com/psf/black
 [poetry]: https://python-poetry.org/
 
 Tools and clients for working with the Dapla Metadata system.

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dapla-toolbelt-metadata"
-version = "0.4.2"
+version = "0.5.0"
 description = "Dapla Toolbelt Metadata"
 authors = ["Team Metadata <metadata@ssb.no>"]
 license = "MIT"
@@ -16,7 +16,7 @@ packages = [{ include = "dapla_metadata", from = "src" }]
 Changelog = "https://github.com/statisticsnorway/dapla-toolbelt-metadata/releases"
 
 [tool.poetry.dependencies]
-python = ">=3.10,<4.0"
+python = ">=3.11,<4.0"
 pyarrow = ">=8.0.0"
 pydantic = ">=2.5.2"
 pandas = ">=1.4.2"
@@ -30,9 +30,9 @@ pyjwt = ">=2.8.0"
 ssb-klass-python = ">=0.0.9"
 ssb-datadoc-model = "^6.0.0"
 typing-extensions = ">=4.12.2"
+ruamel-yaml = "^0.18.10"
 
 [tool.poetry.group.dev.dependencies]
-black = ">=24.8.0"
 pygments = ">=2.18.0"
 coverage = { extras = ["toml"], version = ">=6.2" }
 faker = ">=26.1.0"
@@ -49,7 +49,6 @@ xdoctest = { extras = ["colors"], version = ">=0.15.10" }
 myst-parser = { version = ">=0.16.1" }
 mypy = ">=0.950"
 pytest-cov = ">=3.0.0"
-nbstripout = "^0.8.1"
 python-kacl = "*"
 pytest-mock = ">=3.14.0"
 deptry = ">=0.12.0"
@@ -78,19 +77,14 @@ source = ["dapla_metadata"]
 omit = [
     "tests/*",
     "__init__.py",
-    "*/dapla_metadata/variable_definitions/generated/*",
+    "*/dapla_metadata/variable_definitions/_generated/*",
 ]
 relative_files = true
 
 [tool.coverage.report]
 show_missing = true
 fail_under = 80
-omit = ["*/dapla_metadata/variable_definitions/generated/*"]
-
-[tool.black]
-# We don't want to format generated files because it creates large diffs
-# when generated code is updated.
-extend-exclude = "/generated/"
+omit = ["*/dapla_metadata/variable_definitions/_generated/*"]
 
 [tool.mypy]
 plugins = ["pydantic.mypy"]
@@ -100,10 +94,10 @@ pretty = true
 show_column_numbers = true
 show_error_context = true
 # Generated code is not high quality, just ignore the problems there
-exclude = "generated/vardef_client/.*"
+exclude = "_generated/vardef_client/.*"
 
 [[tool.mypy.overrides]]
-module = ["dapla_metadata.variable_definitions.generated.vardef_client.*"]
+module = ["dapla_metadata.variable_definitions._generated.vardef_client.*"]
 warn_unreachable = false
 ignore_errors = true
 disable_error_code = ["unreachable"]
@@ -141,7 +135,7 @@ disable_error_code = [
 force-exclude = true # Apply excludes to pre-commit
 show-fixes = true
 src = ["src", "tests"]
-target-version = "py310" # Minimum Python version supported
+target-version = "py311" # Minimum Python version supported
 include = ["*.py", "*.pyi", "**/pyproject.toml", "*.ipynb"]
 extend-exclude = [
     "__pycache__",
@@ -149,19 +143,21 @@ extend-exclude = [
     ".ipynb_checkpoints",
     "noxfile.py",
     "docs/conf.py",
+    "_generated/",
 ]
 
 # Ruff rules may be customized as desired: https://docs.astral.sh/ruff/rules/
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-    "ANN101", # Supress missing-type-self.
-    "ANN102", # Supress missing-type-cls.
-    "ANN202", # Don't requiere return type annotation for private functions.
-    "ANN401", # Allow type annotation with type Any.
-    "D100",   # Supress undocumented-public-module. Only doc of public api required.
-    "E402",   # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
-    "E501",   # Supress line-too-long warnings: trust black's judgement on this one.
+    "ANN202",  # Don't requiere return type annotation for private functions.
+    "ANN401",  # Allow type annotation with type Any.
+    "D100",    # Supress undocumented-public-module. Only doc of public api required.
+    "FBT001",  # Allow boolean positional arguments in a function.
+    "FBT002",  # Allow boolean default positional arguments in a function.
+    "E402",    # Supress module-import-not-at-top-of-file, needed in jupyter notebooks.
+    "E501",    # Supress line-too-long warnings: trust black's judgement on this one.
+    "PLR2004", # Allow to compare with unnamed numerical constants.
 ]
 
 [tool.ruff.lint.isort]
@@ -176,6 +172,9 @@ convention = "google" # You can also use "numpy".
 [tool.ruff.lint.flake8-pytest-style]
 fixture-parentheses = false
 
+[tool.ruff.lint.pylint]
+max-args = 8
+
 [tool.ruff.lint.pep8-naming]
 classmethod-decorators = [
     "classmethod",

dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/__init__.py

@@ -0,0 +1,13 @@
+"""Tools and clients for working with the Dapla Metadata system."""
+
+import warnings
+
+warnings.filterwarnings(
+    "ignore",
+    message="As the c extension couldn't be imported, `google-crc32c` is using a pure python implementation that is significantly slower.",
+)
+
+import datadoc_model.model as datadoc_model
+
+from . import datasets
+from . import variable_definitions

dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/dapla/__init__.py

@@ -0,0 +1 @@
+"""Expose information specific to the Dapla platform."""

{dapla_toolbelt_metadata-0.4.2/src/dapla_metadata/_shared → dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/dapla}/user_info.py

@@ -14,6 +14,8 @@ logger = logging.getLogger(__name__)
 
 
 PLACEHOLDER_EMAIL_ADDRESS = "default_user@ssb.no"
+PLACEHOLDER_GROUP = "default-team-developers"
+PLACEHOLDER_TEAM = "default-team"
 
 
 class UserInfo(Protocol):
@@ -27,6 +29,16 @@ class UserInfo(Protocol):
         """Get the short email address."""
         ...
 
+    @property
+    def current_group(self) -> str:
+        """Get the group which the user is currently representing."""
+        ...
+
+    @property
+    def current_team(self) -> str:
+        """Get the team which the user is currently representing."""
+        ...
+
 
 class UnknownUserInfo:
     """Fallback when no implementation is found."""
@@ -36,6 +48,16 @@ class UnknownUserInfo:
         """Unknown email address."""
         return None
 
+    @property
+    def current_group(self) -> str:
+        """Get the group which the user is currently representing."""
+        return ""
+
+    @property
+    def current_team(self) -> str:
+        """Get the team which the user is currently representing."""
+        return ""
+
 
 class TestUserInfo:
     """Information about the current user for local development and testing."""
@@ -45,6 +67,16 @@ class TestUserInfo:
         """Get the short email address."""
         return PLACEHOLDER_EMAIL_ADDRESS
 
+    @property
+    def current_group(self) -> str | None:
+        """Get the group which the user is currently representing."""
+        return PLACEHOLDER_GROUP
+
+    @property
+    def current_team(self) -> str | None:
+        """Get the team which the user is currently representing."""
+        return PLACEHOLDER_TEAM
+
 
 class DaplaLabUserInfo:
     """Information about the current user when running on Dapla Lab."""
@@ -65,6 +97,19 @@ class DaplaLabUserInfo:
         )
         return None
 
+    @property
+    def current_group(self) -> str:
+        """Get the group which the user is currently representing."""
+        if group := config.get_dapla_group_context():
+            return group
+        msg = "DAPLA_GROUP_CONTEXT environment variable not found"
+        raise OSError(msg)
+
+    @property
+    def current_team(self) -> str:
+        """Get the team which the user is currently representing."""
+        return parse_team_name(self.current_group)
+
 
 class JupyterHubUserInfo:
     """Information about the current user when running on JupyterHub."""
@@ -74,6 +119,16 @@ class JupyterHubUserInfo:
         """Get the short email address."""
         return config.get_jupyterhub_user()
 
+    @property
+    def current_group(self) -> str:
+        """Get the group which the user is currently representing."""
+        raise NotImplementedError
+
+    @property
+    def current_team(self) -> str:
+        """Get the team which the user is currently representing."""
+        raise NotImplementedError
+
 
 def get_user_info_for_current_platform() -> UserInfo:
     """Return the correct implementation of UserInfo for the current platform."""
@@ -88,14 +143,6 @@ def get_user_info_for_current_platform() -> UserInfo:
         return UnknownUserInfo()
 
 
-def get_owner() -> str:
-    """Returns the owner read from the GROUP_CONTEXT environment variable."""
-    if group := config.get_dapla_group_context():
-        return parse_team_name(group)
-    msg = "DAPLA_GROUP_CONTEXT environment variable not found"
-    raise OSError(msg)
-
-
 def parse_team_name(group: str) -> str:
     """Parses the group to get the current team.
 

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/code_list.py

@@ -127,7 +127,7 @@ class CodeList(GetExternalSource):
                     .get_codes()
                     .data
                 )
-            except Exception:  # noqa: PERF203
+            except Exception:
                 logger.exception(
                     "Exception while getting classifications from Klass",
                 )

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/core.py

@@ -14,7 +14,7 @@ from datadoc_model import model
 from datadoc_model.model import DataSetStatus
 
 from dapla_metadata._shared import config
-from dapla_metadata._shared import user_info
+from dapla_metadata.dapla import user_info
 from dapla_metadata.datasets.dapla_dataset_path_info import DaplaDatasetPathInfo
 from dapla_metadata.datasets.dataset_parser import DatasetParser
 from dapla_metadata.datasets.model_backwards_compatibility import (

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/dataset_parser.py

@@ -5,7 +5,7 @@ Handles reading in the data and transforming data types to generic metadata type
 
 from __future__ import annotations
 
-import pathlib  # noqa: TCH003 import is needed for docs build
+import pathlib  # noqa: TC003 import is needed for docs build
 import re
 import typing as t
 from abc import ABC

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/model_backwards_compatibility.py

@@ -15,8 +15,8 @@ from __future__ import annotations
 
 from collections import OrderedDict
 from dataclasses import dataclass
+from datetime import UTC
 from datetime import datetime
-from datetime import timezone
 from typing import TYPE_CHECKING
 from typing import Any
 
@@ -305,10 +305,10 @@ def handle_version_2_2_0(supplied_metadata: dict[str, Any]) -> dict[str, Any]:
         )
         supplied_metadata["datadoc"]["variables"][i]["special_value"] = None
         supplied_metadata["datadoc"]["variables"][i]["custom_type"] = None
-        supplied_metadata["datadoc"]["variables"][
-            i
-        ] = _find_and_update_language_strings(
-            supplied_metadata["datadoc"]["variables"][i],
+        supplied_metadata["datadoc"]["variables"][i] = (
+            _find_and_update_language_strings(
+                supplied_metadata["datadoc"]["variables"][i],
+            )
         )
     supplied_metadata["datadoc"]["dataset"]["custom_type"] = None
     supplied_metadata["datadoc"]["dataset"] = _find_and_update_language_strings(
@@ -384,7 +384,7 @@ def handle_version_1_0_0(supplied_metadata: dict[str, Any]) -> dict[str, Any]:
         if supplied_metadata["dataset"][field]:
             supplied_metadata["dataset"][field] = datetime.isoformat(
                 datetime.fromisoformat(supplied_metadata["dataset"][field]).astimezone(
-                    tz=timezone.utc,
+                    tz=UTC,
                 ),
                 timespec="seconds",
             )

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/model_validation.py

@@ -5,11 +5,11 @@ from __future__ import annotations
 import logging
 import warnings
 from typing import TYPE_CHECKING
+from typing import Self
 from typing import TextIO
 
 from datadoc_model import model
 from pydantic import model_validator
-from typing_extensions import Self
 
 from dapla_metadata.datasets.utility.constants import DATE_VALIDATION_MESSAGE
 from dapla_metadata.datasets.utility.constants import NUM_OBLIGATORY_DATASET_FIELDS
@@ -176,7 +176,7 @@ class ObligatoryVariableWarning(UserWarning):
     """Custom warning for checking obligatory metadata for variables."""
 
 
-def custom_warning_handler(  # noqa: PLR0913 remove fields causes incompatible types
+def custom_warning_handler(
     message: Warning | str,
     category: type[Warning],
     filename: str,

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/utility/constants.py

@@ -87,6 +87,7 @@ DATASET_FIELDS_FROM_EXISTING_METADATA = [
     "use_restriction_date",
     "custom_type",
     "owner",
+    "version_description",
 ]
 
 METADATA_DOCUMENT_FILE_SUFFIX = "__DOC.json"

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/utility/enums.py

@@ -11,6 +11,6 @@ class SupportedLanguages(str, Enum):
     Reference: https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
     """
 
-    NORSK_BOKMÅL = "nb"
+    NORSK_BOKMÅL = "nb"  # noqa: PLC2401 the listed problems do not apply in this case
     NORSK_NYNORSK = "nn"
     ENGLISH = "en"

{dapla_toolbelt_metadata-0.4.2 → dapla_toolbelt_metadata-0.5.0}/src/dapla_metadata/datasets/utility/utils.py

@@ -8,13 +8,13 @@ import uuid
 from cloudpathlib import CloudPath
 from cloudpathlib import GSClient
 from cloudpathlib import GSPath
-from dapla import AuthClient
 from datadoc_model import model
 from datadoc_model.model import Assessment
 from datadoc_model.model import DataSetState
 from datadoc_model.model import VariableRole
 
-from dapla_metadata._shared import user_info
+from dapla import AuthClient
+from dapla_metadata.dapla import user_info
 from dapla_metadata.datasets.utility.constants import (
     DATASET_FIELDS_FROM_EXISTING_METADATA,
 )
@@ -37,7 +37,7 @@ logger = logging.getLogger(__name__)
 
 def get_timestamp_now() -> datetime.datetime:
     """Return a timestamp for the current moment."""
-    return datetime.datetime.now(tz=datetime.timezone.utc)
+    return datetime.datetime.now(tz=datetime.UTC)
 
 
 def normalize_path(path: str) -> pathlib.Path | CloudPath:
@@ -79,7 +79,7 @@ def derive_assessment_from_state(state: DataSetState) -> Assessment:
     Returns:
         The derived assessment of the dataset.
     """
-    match (state):
+    match state:
         case (
             DataSetState.INPUT_DATA
             | DataSetState.PROCESSED_DATA
@@ -147,7 +147,7 @@ def set_dataset_owner(dataset: model.Dataset) -> None:
         dataset: The dataset object to set default values on.
     """
     try:
-        dataset.owner = user_info.get_owner()
+        dataset.owner = user_info.get_user_info_for_current_platform().current_team
     except OSError:
         logger.exception("Failed to find environment variable DAPLA_GROUP_CONTEXT")
 
@@ -245,10 +245,7 @@ def _is_missing_multilanguage_value(
             len(field_value[0]) > 0
             and not field_value[0]["languageText"]
             and (len(field_value) <= 1 or not field_value[1]["languageText"])
-            and (
-                len(field_value) <= 2  # noqa: PLR2004 approve magic value
-                or not field_value[2]["languageText"]
-            )
+            and (len(field_value) <= 2 or not field_value[2]["languageText"])
         ),
     )
 
@@ -277,8 +274,7 @@ def _is_missing_metadata(
         True if the field doesn't have a value, False otherwise.
     """
     return bool(
-        field_name in obligatory_list
-        and field_value is None
+        (field_name in obligatory_list and field_value is None)
         or _is_missing_multilanguage_value(
             field_name,
             field_value,

dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/variable_definitions/__init__.py

@@ -0,0 +1,9 @@
+"""Client for working with Variable Definitions at Statistics Norway."""
+
+from ._generated.vardef_client import models
+from ._generated.vardef_client.exceptions import *  # noqa: F403
+from .exceptions import VardefClientError
+from .exceptions import VardefFileError
+from .exceptions import VariableNotFoundError
+from .vardef import Vardef
+from .variable_definition import VariableDefinition

{dapla_toolbelt_metadata-0.4.2/src/dapla_metadata/variable_definitions/generated → dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/variable_definitions/_generated}/.openapi-generator/FILES

@@ -2,21 +2,16 @@ vardef_client/api/__init__.py
 vardef_client/api/data_migration_api.py
 vardef_client/api/draft_variable_definitions_api.py
 vardef_client/api/patches_api.py
-vardef_client/api/public_api.py
 vardef_client/api/validity_periods_api.py
 vardef_client/api/variable_definitions_api.py
 vardef_client/models/__init__.py
 vardef_client/models/complete_response.py
 vardef_client/models/contact.py
 vardef_client/models/draft.py
-vardef_client/models/klass_reference.py
 vardef_client/models/language_string_type.py
 vardef_client/models/owner.py
 vardef_client/models/patch.py
 vardef_client/models/problem.py
-vardef_client/models/rendered_contact.py
-vardef_client/models/rendered_variable_definition.py
-vardef_client/models/supported_languages.py
 vardef_client/models/update_draft.py
 vardef_client/models/validity_period.py
 vardef_client/models/variable_status.py

dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/variable_definitions/_generated/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.11.0

{dapla_toolbelt_metadata-0.4.2/src/dapla_metadata/variable_definitions/generated → dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/variable_definitions/_generated}/vardef_client/__init__.py

@@ -20,7 +20,6 @@ __version__ = "1.0.0"
 from .api.data_migration_api import DataMigrationApi
 from .api.draft_variable_definitions_api import DraftVariableDefinitionsApi
 from .api.patches_api import PatchesApi
-from .api.public_api import PublicApi
 from .api.validity_periods_api import ValidityPeriodsApi
 from .api.variable_definitions_api import VariableDefinitionsApi
 
@@ -39,14 +38,10 @@ from .exceptions import ApiException
 from .models.complete_response import CompleteResponse
 from .models.contact import Contact
 from .models.draft import Draft
-from .models.klass_reference import KlassReference
 from .models.language_string_type import LanguageStringType
 from .models.owner import Owner
 from .models.patch import Patch
 from .models.problem import Problem
-from .models.rendered_contact import RenderedContact
-from .models.rendered_variable_definition import RenderedVariableDefinition
-from .models.supported_languages import SupportedLanguages
 from .models.update_draft import UpdateDraft
 from .models.validity_period import ValidityPeriod
 from .models.variable_status import VariableStatus

{dapla_toolbelt_metadata-0.4.2/src/dapla_metadata/variable_definitions/generated → dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/variable_definitions/_generated}/vardef_client/api/__init__.py

@@ -4,6 +4,5 @@
 from ..api.data_migration_api import DataMigrationApi
 from ..api.draft_variable_definitions_api import DraftVariableDefinitionsApi
 from ..api.patches_api import PatchesApi
-from ..api.public_api import PublicApi
 from ..api.validity_periods_api import ValidityPeriodsApi
 from ..api.variable_definitions_api import VariableDefinitionsApi

{dapla_toolbelt_metadata-0.4.2/src/dapla_metadata/variable_definitions/generated → dapla_toolbelt_metadata-0.5.0/src/dapla_metadata/variable_definitions/_generated}/vardef_client/api/data_migration_api.py

@@ -1,6 +1,6 @@
-"""Variable Definitions
+"""Internal Variable Definitions Administration API
 
-## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
 
 The version of the OpenAPI document: 0.1
 Contact: metadata@ssb.no