okdata-cli 4.1.0__tar.gz → 4.3.0__tar.gz

{okdata-cli-4.1.0 → okdata_cli-4.3.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.1.0/okdata_cli.egg-info → okdata_cli-4.3.0}/PKG-INFO

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: okdata-cli
-Version: 4.1.0
+Version: 4.3.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
@@ -17,6 +17,21 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: PrettyTable
+Requires-Dist: docopt
+Requires-Dist: okdata-sdk<4,>=3.1.1
+Requires-Dist: questionary<2.0.0,>=1.10.0
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # `okdata-cli`: Oslo Origo data services CLI
 

{okdata-cli-4.1.0 → okdata_cli-4.3.0}/okdata/cli/__main__.py

@@ -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)
 

{okdata-cli-4.1.0 → okdata_cli-4.3.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.1.0 → okdata_cli-4.3.0}/okdata/cli/commands/datasets/datasets.py

@@ -6,7 +6,10 @@ from okdata.sdk.data.upload import Upload
 from requests.exceptions import HTTPError
 
 from okdata.cli.command import BaseCommand, BASE_COMMAND_OPTIONS
-from okdata.cli.commands.datasets.wizards import DatasetCreateWizard
+from okdata.cli.commands.datasets.wizards import (
+    DatasetCreateWizard,
+    PipelineCreateWizard,
+)
 from okdata.cli.io import read_json, resolve_output_filepath
 from okdata.cli.output import create_output
 
@@ -22,6 +25,7 @@ Usage:
   okdata datasets create-version <datasetid> [options]
   okdata datasets create-edition <datasetid> [<versionid>] [options]
   okdata datasets create-distribution <datasetid> [<versionid> <editionid>] [options]
+  okdata datasets create-pipeline <datasetid> [options]
 
 Examples:
   okdata datasets ls
@@ -32,6 +36,7 @@ Examples:
   okdata datasets ls my-dataset/1/20240101T102030 --format=json
   okdata datasets create --file=dataset.json
   okdata datasets cp /tmp/file.csv ds:my-dataset-id
+  okdata datasets create-pipeline my-dataset
 
 Options:{BASE_COMMAND_OPTIONS}
   --file=<file>             # Use this file for configuration or upload
@@ -60,6 +65,8 @@ Options:{BASE_COMMAND_OPTIONS}
             self.create_edition()
         elif self.cmd("create-distribution"):
             self.create_distribution()
+        elif self.cmd("create-pipeline"):
+            PipelineCreateWizard(self, self.arg("datasetid")).start()
         else:
             self.help()
 
@@ -261,9 +268,9 @@ Options:{BASE_COMMAND_OPTIONS}
             )
 
     def _dataset_components_from_uri(
-        self, dataset_uri, create_edition=False, auto_resolve=True
+        self, uri, create_edition=False, auto_resolve=True
     ):
-        """Return an ID/version/edition tuple given a dataset URI.
+        """Return a dataset ID/version/edition tuple given a URI.
 
         Four different URI formats are supported:
 
@@ -289,8 +296,15 @@ Options:{BASE_COMMAND_OPTIONS}
 
         Otherwise `None` is returned for missing parts.
         """
-        parts = dataset_uri.split("/")
-        dataset_id, version, edition = parts + [None] * (3 - len(parts))
+        parts = uri.split("/")
+
+        try:
+            dataset_id, version, edition = parts + [None] * (3 - len(parts))
+        except ValueError:
+            sys.exit(
+                "URI must be on the format 'dataset_id', "
+                "'dataset_id/version', or 'dataset_id/version/edition'."
+            )
 
         # First verify that the dataset exists; `get_dataset` raises an error
         # if not.

{okdata-cli-4.1.0 → okdata_cli-4.3.0}/okdata/cli/commands/datasets/questions.py

@@ -26,7 +26,7 @@ available_pipelines = [
 ]
 
 
-def qs_create():
+def qs_create_dataset():
     return [
         {
             **required_style,
@@ -35,7 +35,7 @@ def qs_create():
             "message": "Datakilde",
             "choices": [
                 Choice("Fil", "file"),
-                Choice("Database (krever eget databaseoppsett)", "database"),
+                Choice("Punktmålinger", "event"),
                 Choice("Ingen (datasettet skal ikke inneholde data direkte)", "none"),
             ],
         },
@@ -62,9 +62,9 @@ def qs_create():
             "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"),
             ],
         },
         {
@@ -114,3 +114,15 @@ def qs_create():
             "when": lambda x: x["sourceType"] in pipeline_choices,
         },
     ]
+
+
+def qs_create_pipeline():
+    return [
+        {
+            **required_style,
+            "type": "select",
+            "name": "pipeline",
+            "message": "Prosessering",
+            "choices": pipeline_choices["file"],
+        },
+    ]

okdata_cli-4.3.0/okdata/cli/commands/datasets/wizards.py

@@ -0,0 +1,131 @@
+import sys
+
+from okdata.sdk.data.dataset import Dataset
+from okdata.sdk.pipelines.client import PipelineApiClient
+from requests import HTTPError
+
+from okdata.cli.command import confirm_to_continue
+from okdata.cli.commands.datasets.questions import qs_create_dataset, qs_create_pipeline
+from okdata.cli.commands.wizard import run_questionnaire
+
+
+def _pipeline_config(pipeline_processor_id, dataset_id, version):
+    return {
+        "pipelineProcessorId": pipeline_processor_id,
+        "id": dataset_id,
+        "datasetUri": f"output/{dataset_id}/{version}",
+    }
+
+
+def _pipeline_input_config(pipeline_id, dataset_id, version):
+    return {
+        "pipelineInstanceId": pipeline_id,
+        "datasetUri": f"input/{dataset_id}/{version}",
+        "stage": "raw",
+    }
+
+
+def _create_pipeline(command, env, dataset_id, pipeline):
+    command.print("Creating pipeline...")
+    pipeline_client = PipelineApiClient(env=env)
+    pipeline_config = _pipeline_config(pipeline, dataset_id, "1")
+    pipeline_id = pipeline_client.create_pipeline_instance(pipeline_config)
+    pipeline_id = pipeline_id.strip('"')  # What's up with these?
+    command.print(f"Created pipeline with ID: {pipeline_id}")
+
+    command.print("Creating pipeline input...")
+    pipeline_input_config = _pipeline_input_config(pipeline_id, dataset_id, "1")
+    pipeline_input_id = pipeline_client.create_pipeline_input(pipeline_input_config)
+    pipeline_input_id = pipeline_input_id.strip('"')  # What's up with these?
+    command.print(f"Created pipeline input with ID: {pipeline_input_id}")
+
+
+class DatasetCreateWizard:
+    """Wizard for the `datasets create` command.
+
+    Creates a new dataset with an optional pipeline based on the answers from a
+    questionnaire.
+    """
+
+    def __init__(self, command):
+        self.command = command
+
+    def dataset_config(self, choices):
+        title = choices["title"]
+        access_rights = choices["accessRights"]
+
+        config = {
+            "title": title,
+            "description": choices["description"] or title,
+            "keywords": choices["keywords"],
+            "accessRights": access_rights,
+            "source": {"type": choices["sourceType"]},
+            "objective": choices["objective"] or title,
+            "contactPoint": {
+                "name": choices["name"],
+                "email": choices["email"],
+            },
+            "publisher": choices["publisher"],
+        }
+
+        if choices.get("license"):
+            config["license"] = choices["license"]
+
+        return config
+
+    def start(self):
+        env = self.command.opt("env")
+        choices = run_questionnaire(*qs_create_dataset())
+
+        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)
+        dataset = dataset_client.create_dataset(dataset_config)
+        dataset_id = dataset["Id"]
+        self.command.print(f"Created dataset with ID: {dataset_id}")
+
+        if choices.get("pipeline"):
+            _create_pipeline(self.command, env, dataset_id, choices["pipeline"])
+
+        if choices["sourceType"] == "file":
+            self.command.print(
+                f"""Done! You may go ahead and upload data to the dataset by running:
+
+  okdata datasets cp FILE ds:{dataset_id}
+"""
+            )
+        else:
+            self.command.print("Done!")
+
+
+class PipelineCreateWizard:
+    """Wizard for the `datasets create-pipeline` command."""
+
+    def __init__(self, command, dataset_id):
+        self.command = command
+        self.dataset_id = dataset_id
+
+    def start(self):
+        choices = run_questionnaire(*qs_create_pipeline())
+        try:
+            _create_pipeline(
+                self.command,
+                self.command.opt("env"),
+                self.dataset_id,
+                choices["pipeline"],
+            )
+        except HTTPError as e:
+            if e.response.status_code == 409:
+                sys.exit("This dataset already has a pipeline set up.")
+            raise

{okdata-cli-4.1.0 → okdata_cli-4.3.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.1.0 → okdata_cli-4.3.0}/okdata/cli/commands/pubs/questions.py

@@ -216,6 +216,7 @@ def q_delete_from_aws():
         "name": "delete_from_aws",
         "message": "Delete key from AWS Parameter Store?",
         "auto_enter": False,
+        "default": False,
     }
 
 

{okdata-cli-4.1.0 → okdata_cli-4.3.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.1.0 → okdata_cli-4.3.0/okdata_cli.egg-info}/PKG-INFO

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: okdata-cli
-Version: 4.1.0
+Version: 4.3.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
@@ -17,6 +17,21 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: PrettyTable
+Requires-Dist: docopt
+Requires-Dist: okdata-sdk<4,>=3.1.1
+Requires-Dist: questionary<2.0.0,>=1.10.0
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # `okdata-cli`: Oslo Origo data services CLI
 

{okdata-cli-4.1.0 → okdata_cli-4.3.0}/setup.py

@@ -5,9 +5,9 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="okdata-cli",
-    version="4.1.0",
+    version="4.3.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,

okdata-cli-4.1.0/okdata/cli/commands/datasets/wizards.py

@@ -1,92 +0,0 @@
-from okdata.sdk.data.dataset import Dataset
-from okdata.sdk.pipelines.client import PipelineApiClient
-
-from okdata.cli.commands.datasets.questions import qs_create
-from okdata.cli.commands.wizard import run_questionnaire
-
-
-class DatasetCreateWizard:
-    """Wizard for the `datasets create` command.
-
-    Creates a new dataset with an optional pipeline based on the answers from a
-    questionnaire.
-    """
-
-    def __init__(self, command):
-        self.command = command
-
-    def dataset_config(self, choices):
-        title = choices["title"]
-        access_rights = choices["accessRights"]
-
-        config = {
-            "title": title,
-            "description": choices["description"] or title,
-            "keywords": choices["keywords"],
-            "accessRights": access_rights,
-            "source": {"type": choices["sourceType"]},
-            "objective": choices["objective"] or title,
-            "contactPoint": {
-                "name": choices["name"],
-                "email": choices["email"],
-            },
-            "publisher": choices["publisher"],
-        }
-
-        if choices.get("license"):
-            config["license"] = choices["license"]
-
-        return config
-
-    def pipeline_config(self, pipeline_processor_id, dataset_id, version):
-        return {
-            "pipelineProcessorId": pipeline_processor_id,
-            "id": dataset_id,
-            "datasetUri": f"output/{dataset_id}/{version}",
-        }
-
-    def pipeline_input_config(self, pipeline_id, dataset_id, version):
-        return {
-            "pipelineInstanceId": pipeline_id,
-            "datasetUri": f"input/{dataset_id}/{version}",
-            "stage": "raw",
-        }
-
-    def start(self):
-        env = self.command.opt("env")
-        choices = run_questionnaire(*qs_create())
-
-        self.command.print("Creating dataset...")
-        dataset_client = Dataset(env=env)
-        dataset_config = self.dataset_config(choices)
-        dataset = dataset_client.create_dataset(dataset_config)
-        dataset_id = dataset["Id"]
-        self.command.print(f"Created dataset with ID: {dataset_id}")
-
-        if choices.get("pipeline"):
-            self.command.print("Creating pipeline...")
-            pipeline_client = PipelineApiClient(env=env)
-            pipeline_config = self.pipeline_config(choices["pipeline"], dataset_id, "1")
-            pipeline_id = pipeline_client.create_pipeline_instance(pipeline_config)
-            pipeline_id = pipeline_id.strip('"')  # What's up with these?
-            self.command.print(f"Created pipeline with ID: {pipeline_id}")
-
-            self.command.print("Creating pipeline input...")
-            pipeline_input_config = self.pipeline_input_config(
-                pipeline_id, dataset_id, "1"
-            )
-            pipeline_input_id = pipeline_client.create_pipeline_input(
-                pipeline_input_config
-            )
-            pipeline_input_id = pipeline_input_id.strip('"')  # What's up with these?
-            self.command.print(f"Created pipeline input with ID: {pipeline_input_id}")
-
-        if choices["sourceType"] == "file":
-            self.command.print(
-                f"""Done! You may go ahead and upload data to the dataset by running:
-
-  okdata datasets cp FILE ds:{dataset_id}
-"""
-            )
-        else:
-            self.command.print("Done!")