dapla-toolbelt-metadata 0.9.0__tar.gz → 0.9.1__tar.gz

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dapla-toolbelt-metadata
-Version: 0.9.0
+Version: 0.9.1
 Summary: Dapla Toolbelt Metadata
 Project-URL: homepage, https://github.com/statisticsnorway/dapla-toolbelt-metadata
 Project-URL: repository, https://github.com/statisticsnorway/dapla-toolbelt-metadata

dapla_toolbelt_metadata-0.9.1/demo/variable_definitions/reserver_kortnavn.ipynb

@@ -0,0 +1,137 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Reserver kortnavn\n",
+    "\n",
+    "Denne Notebook er for deg som:\n",
+    "\n",
+    "- Har behov å reservere kortnavn ved å opprette utkast. Det er særlig til bruk for basisregisterteamene som har mange variabler og vil unngå at kortnavn tas av andre.\n",
+    "\n",
+    "Forutsetninger:\n",
+    "\n",
+    "- Et Dapla-team som skal eie variabeldefinisjonene.\n",
+    "- En liste av kortnavn du ønsker å reservere.\n",
+    "\n",
+    "Forbehold:\n",
+    "\n",
+    "- Variabeldefinisjonene er opprettet med status UTKAST. Det gjør at andre ikke får lov til å opprette nye variabeldefinisjoner med samme kortnavn, men de er ikke klare til å tas i bruk eller publiseres.\n",
+    "- Standardverdier er satt inn i alle påbudte felt. Disse må gjennomgås og korrigeres før publisering."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Oppsett\n",
+    "\n",
+    "Koden under kjøres som forberedelse for påfølgende steg"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Nødvendig import\n",
+    "import logging\n",
+    "import sys\n",
+    "\n",
+    "from dapla_metadata.variable_definitions import Vardef\n",
+    "from dapla_metadata.variable_definitions import models\n",
+    "\n",
+    "# Redusere størrelsen på Traceback for mer tydelige feilmeldinger\n",
+    "%xmode Minimal\n",
+    "\n",
+    "# Gjøre at logging vises\n",
+    "logging.basicConfig(\n",
+    "    format=\"%(levelname)s: %(message)s\",\n",
+    "    level=logging.INFO,\n",
+    "    stream=sys.stdout,\n",
+    "    force=True,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Liste opp kortnavn som skal reserveres\n",
+    "\n",
+    "Skriv inn de kortnavnene"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "mine_kortnavn = [\"a\"]\n",
+    "print(f\"✅ {len(mine_kortnavn)} reserveres\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Reservere kortnavn\n",
+    "\n",
+    "⭐️ I koden under opprettes nye variabeldefinisjoner med spesifiserte kortnavn"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dapla_metadata.variable_definitions import DEFAULT_DATE\n",
+    "from dapla_metadata.variable_definitions import GENERATED_CONTACT\n",
+    "\n",
+    "opprettet = []\n",
+    "feil = []\n",
+    "for kortnavn in mine_kortnavn:\n",
+    "    try:\n",
+    "        mitt_kortnavn = Vardef.create_draft(\n",
+    "            draft=models.Draft(\n",
+    "                name=models.LanguageStringType(nb=\"Reservert\"),\n",
+    "                short_name=kortnavn,\n",
+    "                definition=models.LanguageStringType(\n",
+    "                    nb=\"Definisjonstekst\",\n",
+    "                ),\n",
+    "                unit_types=[\"99\"],\n",
+    "                subject_fields=[\"al\"],\n",
+    "                contains_special_categories_of_personal_data=False,\n",
+    "                valid_from=DEFAULT_DATE,\n",
+    "                contact=GENERATED_CONTACT,\n",
+    "            )\n",
+    "        )\n",
+    "        opprettet.append(mitt_kortnavn)\n",
+    "    except Exception as e:\n",
+    "        print(f\"⚠️ Feil under opprettelse av '{kortnavn}': {e}\")\n",
+    "        feil.append((kortnavn, str(e)))\n",
+    "\n",
+    "print(\"\\n📊 Resultatoppsummering:\")\n",
+    "print(f\" - Antall opprettet: {len(opprettet)}\")\n",
+    "print(f\" - Antall feilet: {len(feil)}\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython"
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/pyproject.toml

@@ -2,7 +2,7 @@
 name = "dapla-toolbelt-metadata"
 description = "Dapla Toolbelt Metadata"
 license = "MIT"
-version = "0.9.0"
+version = "0.9.1"
 classifiers = ["Development Status :: 4 - Beta"]
 readme = "README.md"
 authors = [{ name = "Statistics Norway", email = "metadata@ssb.no" }]

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/src/dapla_metadata/variable_definitions/__init__.py

@@ -2,6 +2,8 @@
 
 from ._generated.vardef_client import models
 from ._generated.vardef_client.exceptions import *  # noqa: F403
+from ._utils.constants import DEFAULT_DATE
+from ._utils.constants import GENERATED_CONTACT
 from .exceptions import VardefClientError
 from .exceptions import VardefFileError
 from .exceptions import VariableNotFoundError

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/src/dapla_metadata/variable_definitions/_utils/constants.py

@@ -2,6 +2,13 @@
 
 from datetime import date
 
+from dapla_metadata.variable_definitions._generated.vardef_client.models.contact import (
+    Contact,
+)
+from dapla_metadata.variable_definitions._generated.vardef_client.models.language_string_type import (
+    LanguageStringType,
+)
+
 VARIABLE_DEFINITIONS_DIR = "variable_definitions"
 
 VARIABLE_STATUS_FIELD_NAME = "variable_status"
@@ -26,6 +33,13 @@ TEMPLATE_SECTION_HEADER_MACHINE_GENERATED_EN = (
 
 DEFAULT_DATE = date(1000, 1, 1)
 
+GENERATED_CONTACT = Contact(
+    title=LanguageStringType(
+        nb="generert tittel",
+    ),
+    email="generert@ssb.no",
+)
+
 MACHINE_GENERATED_FIELDS = [
     "id",
     "patch_id",

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/src/dapla_metadata/variable_definitions/_utils/template_files.py

@@ -4,9 +4,6 @@ from typing import TYPE_CHECKING
 from dapla_metadata.variable_definitions._generated.vardef_client.models.complete_response import (
     CompleteResponse,
 )
-from dapla_metadata.variable_definitions._generated.vardef_client.models.contact import (
-    Contact,
-)
 from dapla_metadata.variable_definitions._generated.vardef_client.models.language_string_type import (
     LanguageStringType,
 )
@@ -17,6 +14,7 @@ from dapla_metadata.variable_definitions._generated.vardef_client.models.variabl
     VariableStatus,
 )
 from dapla_metadata.variable_definitions._utils.constants import DEFAULT_DATE
+from dapla_metadata.variable_definitions._utils.constants import GENERATED_CONTACT
 from dapla_metadata.variable_definitions._utils.constants import TEMPLATE_HEADER
 from dapla_metadata.variable_definitions._utils.files import _create_file_name
 from dapla_metadata.variable_definitions._utils.files import _get_current_time
@@ -35,6 +33,7 @@ if TYPE_CHECKING:
 
 
 def _get_default_template() -> "VariableDefinition":
+    # Import is needed here to avoid circular imports
     from dapla_metadata.variable_definitions.variable_definition import (
         VariableDefinition,
     )
@@ -52,12 +51,7 @@ def _get_default_template() -> "VariableDefinition":
         subject_fields=[""],
         contains_special_categories_of_personal_data=False,
         owner=Owner(team="default team", groups=["default group"]),
-        contact=Contact(
-            title=LanguageStringType(
-                nb="generert tittel",
-            ),
-            email="generert@ssb.no",
-        ),
+        contact=GENERATED_CONTACT,
         variable_status=VariableStatus.DRAFT.value,
         id="",
         patch_id=0,

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/tests/variable_definitions/conftest.py

@@ -1,4 +1,5 @@
 import os
+import traceback
 from collections.abc import Generator
 from datetime import date
 from datetime import datetime
@@ -82,7 +83,8 @@ def vardef_mock_service() -> Generator[MicrocksContainer | None]:
                 str(OPENAPI_DIR / "variable-definitions-internal.yml"),
             )
             yield container
-    except docker.errors.DockerException:
+    except docker.errors.DockerException as e:
+        traceback.print_exception(e)
         yield None
 
 

{dapla_toolbelt_metadata-0.9.0 → dapla_toolbelt_metadata-0.9.1}/vardef-maintenance/README.md

@@ -17,3 +17,7 @@ The service vardef-forvaltning is a copy of the existing Jupyter service, with t
 It is also possible to supply arguments to the init script with `personalInitArgs`, for example to specify the branch from which to retrieve files with `"--branch=dpmeta-837-vardef-init-script"`
 
 In the future we may wish to make further changes, such as reducing the options available to the user.
+
+## Dependency specification
+
+In [./vardef-maintenance.toml](./vardef-maintenance.toml) we use a Poetry compatible configuration. This is becayse we use the `ssb-project` tool to install the dependencies and a kernel and that supports Poetry. It is desirable to change to using `uv` for installation and configuration once this is supported.

dapla_toolbelt_metadata-0.9.1/vardef-maintenance/vardef-maintenance.toml

@@ -0,0 +1,13 @@
+[project]
+name = "vardef-maintenance"
+version = "0.1.0"
+description = "Dependencies necessary to run Notebooks for maintenance of variable definitions at Statistics Norway."
+requires-python = "^3.10"                                                                                             # This should match the range in dapla-toolbelt-metadata
+dependencies = ["dapla-toolbelt-metadata>=0.9.1", "ipykernel"]
+
+[tool.poetry]
+package-mode = false # We don't want to install this "project", just the dependencies
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

dapla_toolbelt_metadata-0.9.0/vardef-maintenance/vardef-maintenance.toml

@@ -1,14 +0,0 @@
-[project]
-name = "vardef-maintenance"
-version = "0.1.0"
-description = "Dependencies necessary to run Notebooks for maintenance of variable definitions at Statistics Norway."
-requires-python = "^3.10" # This should match the range in dapla-toolbelt-metadata
-dependencies = ["dapla-toolbelt-metadata>=0.6.2", "ipykernel"]
-
-[tool.poetry]
-package-mode = false  # We don't want to install this "project", just the dependencies
-
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"