okdata-cli 4.0.0__tar.gz → 4.2.0__tar.gz

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Oslo Origo
+Copyright (c) 2019-2024 Oslo Origo
 
 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:
 

{okdata-cli-4.0.0/okdata_cli.egg-info → okdata-cli-4.2.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: okdata-cli
-Version: 4.0.0
+Version: 4.2.0
 Summary: CLI for services provided by Oslo Origo
 Home-page: https://github.com/oslokommune/okdata-cli/
 Author: Oslo Origo
-Author-email: dataplattform@oslo.kommune.no
+Author-email: dataspeilet@oslo.kommune.no
 License: MIT
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3.8

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/__main__.py

@@ -1,7 +1,7 @@
 import json
 import sys
 
-from keycloak.exceptions import KeycloakGetError
+from keycloak.exceptions import KeycloakGetError, KeycloakPostError
 from okdata.sdk.exceptions import ApiAuthenticateError
 from requests.exceptions import RequestException
 
@@ -16,9 +16,15 @@ from okdata.cli.commands.teams.teams import TeamsCommand
 
 def main():
     argv = sys.argv
-    if len(argv) < 2 or argv[1] == "help":
+    if len(argv) < 2:
         BaseCommand().help()
         return
+    if argv[1] in ("-e", "--environment"):
+        BaseCommand().print_env()
+        return
+    if argv[1] in ("-v", "--version"):
+        BaseCommand().print_version()
+        return
 
     command = get_command_class(argv)
 
@@ -40,11 +46,12 @@ def main():
                 "An error occurred (ApiAuthenticateError): Invalid credentials",
                 {"error": 1, "message": "Invalid credentials"},
             )
-        except KeycloakGetError as e:
+        except (KeycloakGetError, KeycloakPostError) as e:
             error = json.loads(e.error_message)
+            error_type = e.__class__.__name__
             instance.log.info(f"Keycloak reported: {e}")
             instance.print(
-                f"An error occurred (KeycloakGetError): {error['error_description']}"
+                f"An error occurred ({error_type}): {error['error_description']}"
             )
         except (EOFError, KeyboardInterrupt):
             instance.print("\nAbort.")

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/command.py

@@ -24,7 +24,9 @@ usage:
   okdata pubs [options]
   okdata status [options]
   okdata teams [options]
+  okdata -e | --environment
   okdata -h | --help
+  okdata -v | --version
 
 Commands available:
   datasets
@@ -89,16 +91,6 @@ Options:{BASE_COMMAND_OPTIONS}
             else:
                 print(payload)
 
-    def confirm_to_continue(self, message):
-        """Ask the user for confirmation before continuing.
-
-        Any answer other than "y" will exit the program.
-        """
-        self.print(message)
-        if input("Continue? [y/N]: ") != "y":
-            self.print("Abort.")
-            sys.exit()
-
     def login(self):
         self.sdk.login()
 
@@ -119,6 +111,12 @@ Options:{BASE_COMMAND_OPTIONS}
     def help(self):
         print(self.__doc__, end="")
 
+    def print_env(self):
+        print(self.sdk.config.resolve_environment(None))
+
+    def print_version(self):
+        print(self.version)
+
     def print_error_response(self, response_body):
         if not isinstance(response_body, dict):
             print(response_body)
@@ -140,6 +138,17 @@ Options:{BASE_COMMAND_OPTIONS}
                 print(response_body)
 
 
+def confirm_to_continue(message):
+    """Ask the user for confirmation before continuing.
+
+    Any answer other than "y" will exit the program.
+    """
+    print(message)
+    if input("Continue? [y/N]: ") != "y":
+        print("Abort.")
+        sys.exit()
+
+
 def _format_error_message(message, errors=None):
     msg = f"An error occurred: {message}"
     sep = "\n - "

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/commands/datasets/questions.py

@@ -2,11 +2,7 @@ from questionary import Choice
 
 from okdata.cli.commands.validators import (
     KeywordValidator,
-    PhoneValidator,
     SimpleEmailValidator,
-    SpatialResolutionValidator,
-    SpatialValidator,
-    StandardsValidator,
     TitleValidator,
 )
 from okdata.cli.commands.wizard import filter_comma_separated, required_style
@@ -15,6 +11,7 @@ pipeline_choices = {
     "file": [
         Choice("Lagre dataen slik den er", "data-copy"),
         Choice("Konverter fra CSV til Delta", "csv-to-delta"),
+        Choice("Konverter fra JSON til Delta", "json-to-delta"),
         Choice("Konverter fra CSV til Parquet", "csv-to-parquet"),
         Choice("Konverter fra Excel til CSV", "pipeline-excel-to-csv"),
         Choice("Ingen prosessering (krever manuell konfigurasjon av pipeline)", False),
@@ -29,7 +26,7 @@ available_pipelines = [
 ]
 
 
-def qs_create(include_extra_metadata=True):
+def qs_create():
     return [
         {
             **required_style,
@@ -59,47 +56,15 @@ def qs_create(include_extra_metadata=True):
             "validate": KeywordValidator,
             "filter": filter_comma_separated,
         },
-        {
-            **required_style,
-            "type": "confirm",
-            "name": "contains_geodata",
-            "message": "Inneholder datasettet geodata?",
-            "default": False,
-            "when": lambda x: include_extra_metadata,
-        },
-        {
-            "type": "text",
-            "name": "spatial",
-            "message": "Romlig avgrensning (komma-separert)",
-            "validate": SpatialValidator,
-            "filter": filter_comma_separated,
-            "when": lambda x: include_extra_metadata and x["contains_geodata"],
-        },
-        {
-            "type": "text",
-            "name": "spatialResolutionInMeters",
-            "message": "Romlig oppløsning (i meter)",
-            "validate": SpatialResolutionValidator,
-            "filter": lambda v: float(v.replace(",", ".")) if v else None,
-            "when": lambda x: include_extra_metadata and x["contains_geodata"],
-        },
-        {
-            "type": "text",
-            "name": "conformsTo",
-            "message": "I samsvar med standarder (komma-separert)",
-            "validate": StandardsValidator,
-            "filter": filter_comma_separated,
-            "when": lambda x: include_extra_metadata,
-        },
         {
             **required_style,
             "type": "select",
             "name": "accessRights",
             "message": "Tilgangsnivå",
             "choices": [
+                Choice("Eksplisitt tilgangskontroll", "non-public"),
+                Choice("Internt til Origo", "restricted"),
                 Choice("Offentlig", "public"),
-                Choice("Begrenset offentlighet", "restricted"),
-                Choice("Unntatt offentlighet", "non-public"),
             ],
         },
         {
@@ -130,7 +95,6 @@ def qs_create(include_extra_metadata=True):
                     "http://creativecommons.org/publicdomain/zero/1.0/",
                 ),
             ],
-            "when": lambda x: include_extra_metadata,
         },
         {"type": "text", "name": "name", "message": "Kontaktperson – navn"},
         {
@@ -140,13 +104,6 @@ def qs_create(include_extra_metadata=True):
             "message": "Kontaktperson – epost",
             "validate": SimpleEmailValidator,
         },
-        {
-            **required_style,
-            "type": "text",
-            "name": "phone",
-            "message": "Kontaktperson – telefon",
-            "validate": PhoneValidator,
-        },
         {"type": "text", "name": "publisher", "message": "Utgiver"},
         {
             **required_style,

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/commands/datasets/wizards.py

@@ -1,6 +1,7 @@
 from okdata.sdk.data.dataset import Dataset
 from okdata.sdk.pipelines.client import PipelineApiClient
 
+from okdata.cli.command import confirm_to_continue
 from okdata.cli.commands.datasets.questions import qs_create
 from okdata.cli.commands.wizard import run_questionnaire
 
@@ -29,17 +30,10 @@ class DatasetCreateWizard:
             "contactPoint": {
                 "name": choices["name"],
                 "email": choices["email"],
-                "phone": choices["phone"],
             },
             "publisher": choices["publisher"],
         }
 
-        if choices.get("spatial"):
-            config["spatial"] = choices["spatial"]
-        if choices.get("spatialResolutionInMeters"):
-            config["spatialResolutionInMeters"] = choices["spatialResolutionInMeters"]
-        if choices.get("conformsTo"):
-            config["conformsTo"] = choices["conformsTo"]
         if choices.get("license"):
             config["license"] = choices["license"]
 
@@ -63,6 +57,17 @@ class DatasetCreateWizard:
         env = self.command.opt("env")
         choices = run_questionnaire(*qs_create())
 
+        confirm_to_continue(
+            "Will create a new dataset '{}'.{}".format(
+                choices["title"],
+                (
+                    "\n\nData uploaded to the dataset will be PUBLICLY AVAILABLE ON THE INTERNET.\n"
+                    if choices["accessRights"] == "public"
+                    else ""
+                ),
+            )
+        )
+
         self.command.print("Creating dataset...")
         dataset_client = Dataset(env=env)
         dataset_config = self.dataset_config(choices)

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/commands/pubs/pubs.py

@@ -5,7 +5,7 @@ from operator import itemgetter
 from okdata.sdk.team.client import TeamClient
 
 from okdata.cli import MAINTAINER
-from okdata.cli.command import BASE_COMMAND_OPTIONS, BaseCommand
+from okdata.cli.command import BASE_COMMAND_OPTIONS, BaseCommand, confirm_to_continue
 from okdata.cli.commands.pubs.client import PubsClient
 from okdata.cli.commands.pubs.questions import (
     NoClientsError,
@@ -88,7 +88,7 @@ Options:{BASE_COMMAND_OPTIONS}
         scopes = config["scopes"]
         env = config["env"]
 
-        self.confirm_to_continue(
+        confirm_to_continue(
             "Will create a new {} client{} in {}{}.".format(
                 client_types[client_type_id],
                 f" for {providers[provider_id]}" if provider_id else "",
@@ -138,7 +138,7 @@ You may now go ahead and create a key for it by running:
         aws_account = choices["aws_account"]
         aws_region = choices["aws_region"]
 
-        self.confirm_to_continue(
+        confirm_to_continue(
             "Will delete client '{}' [{}]{}.".format(
                 client_name,
                 env,
@@ -241,7 +241,7 @@ You may now go ahead and create a key for it by running:
         aws_region = config["aws_region"]
         enable_auto_rotate = config["enable_auto_rotate"]
 
-        self.confirm_to_continue(
+        confirm_to_continue(
             "\n\n".join(
                 [
                     "Will create a new key for client '{}' in {} and {}.".format(
@@ -327,9 +327,7 @@ You may now go ahead and create a key for it by running:
         client_name = choices["client_name"]
         key_id = choices["key_id"]
 
-        self.confirm_to_continue(
-            f"Will delete key '{key_id}' from '{client_name}' [{env}]."
-        )
+        confirm_to_continue(f"Will delete key '{key_id}' from '{client_name}' [{env}].")
 
         self.print(f"Deleting key '{key_id}' from '{client_name}' [{env}]...")
         self.pubs_client.delete_key(env, client_id, key_id)

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/commands/teams/teams.py

@@ -3,7 +3,7 @@ from operator import itemgetter
 from okdata.sdk.team.client import TeamClient
 
 from okdata.cli import MAINTAINER
-from okdata.cli.command import BASE_COMMAND_OPTIONS, BaseCommand
+from okdata.cli.command import BASE_COMMAND_OPTIONS, BaseCommand, confirm_to_continue
 from okdata.cli.commands.teams.questions import NoTeamError
 from okdata.cli.commands.teams.util import (
     member_representation,
@@ -122,9 +122,7 @@ Options:{BASE_COMMAND_OPTIONS}
             )
             return
 
-        self.confirm_to_continue(
-            "Add {} to the team?".format(member_representation(user))
-        )
+        confirm_to_continue("Add {} to the team?".format(member_representation(user)))
 
         self.client.update_team_members(
             config["team_id"], team_members + [user["username"]]
@@ -150,13 +148,13 @@ Options:{BASE_COMMAND_OPTIONS}
                 members_to_keep.append(member)
 
         if len(members_to_keep) == 0:
-            self.confirm_to_continue(
+            confirm_to_continue(
                 "You are about to delete all members from the team, including "
                 "yourself. It will not be possible to edit this team any "
                 "further without being re-added by a systems administrator."
             )
         else:
-            self.confirm_to_continue(
+            confirm_to_continue(
                 "Remove the following member{} from the team?\n - {}".format(
                     "s" if len(members_to_remove) > 1 else "",
                     "\n - ".join(

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/commands/validators.py

@@ -33,15 +33,6 @@ class SimpleEmailValidator(Validator):
             )
 
 
-class PhoneValidator(Validator):
-    def validate(self, document):
-        if not re.match(r"^[0-9]+$", document.text):
-            raise ValidationError(
-                message="Please enter a valid phone - all numbers and no space, example: 232334455",
-                cursor_position=len(document.text),
-            )
-
-
 class TitleValidator(Validator):
     def validate(self, document):
         if len(document.text) < 5:
@@ -70,60 +61,6 @@ class KeywordValidator(Validator):
             )
 
 
-class StandardsValidator(Validator):
-    def validate(self, document):
-        standards = csv.reader(
-            [document.text], delimiter=",", escapechar="\\", skipinitialspace=True
-        )
-        standards = [x.strip() for x in next(standards)]
-        for standard in standards:
-            if len(standard) < 3:
-                raise ValidationError(
-                    message="Each standard reference must be at least 3 characters",
-                    cursor_position=len(document.text),
-                )
-        if len(standards) != len(set(standards)):
-            raise ValidationError(
-                message="Each standard reference must be unique",
-                cursor_position=len(document.text),
-            )
-
-
-class SpatialValidator(Validator):
-    def validate(self, document):
-        locations = csv.reader(
-            [document.text], delimiter=",", escapechar="\\", skipinitialspace=True
-        )
-        locations = [x.strip() for x in next(locations)]
-        for location in locations:
-            if len(location) < 1:
-                raise ValidationError(
-                    message="Each location must be at least 1 character",
-                    cursor_position=len(document.text),
-                )
-        if len(locations) != len(set(locations)):
-            raise ValidationError(
-                message="Each location must be unique",
-                cursor_position=len(document.text),
-            )
-
-
-class SpatialResolutionValidator(Validator):
-    def validate(self, document):
-        if not document.text:
-            return None
-        try:
-            number = float(document.text.replace(",", "."))
-            if number <= 0:
-                raise ValueError
-        except ValueError:
-            raise ValidationError(
-                message="Please enter a positive (decimal) number",
-                cursor_position=len(document.text),
-            )
-        return None
-
-
 class IntegrationValidator(Validator):
     def validate(self, document):
         if len(document.text) > 30:

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata/cli/data/output-format/datasets_dataset_config.json

@@ -16,7 +16,6 @@
     "key": "contactPoint",
     "fields": [
       "name",
-      "phone",
       "email"
     ]
   }

{okdata-cli-4.0.0 → okdata-cli-4.2.0/okdata_cli.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: okdata-cli
-Version: 4.0.0
+Version: 4.2.0
 Summary: CLI for services provided by Oslo Origo
 Home-page: https://github.com/oslokommune/okdata-cli/
 Author: Oslo Origo
-Author-email: dataplattform@oslo.kommune.no
+Author-email: dataspeilet@oslo.kommune.no
 License: MIT
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3.8

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/okdata_cli.egg-info/requires.txt

@@ -1,5 +1,5 @@
 PrettyTable
 docopt
-okdata-sdk<4,>=3.1
+okdata-sdk<4,>=3.1.1
 questionary<2.0.0,>=1.10.0
 requests

{okdata-cli-4.0.0 → okdata-cli-4.2.0}/setup.py

@@ -5,9 +5,9 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="okdata-cli",
-    version="4.0.0",
+    version="4.2.0",
     author="Oslo Origo",
-    author_email="dataplattform@oslo.kommune.no",
+    author_email="dataspeilet@oslo.kommune.no",
     description="CLI for services provided by Oslo Origo",
     license="MIT",
     long_description=long_description,
@@ -25,7 +25,7 @@ setuptools.setup(
     install_requires=[
         "PrettyTable",
         "docopt",
-        "okdata-sdk>=3.1,<4",
+        "okdata-sdk>=3.1.1,<4",
         "questionary>=1.10.0,<2.0.0",
         "requests",
     ],