okdata-cli 1.6.0__tar.gz → 2.0.1__tar.gz

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: okdata-cli
-Version: 1.6.0
+Version: 2.0.1
 Summary: CLI for services provided by Oslo Origo
 Home-page: https://github.com/oslokommune/okdata-cli/
 Author: Oslo Origo
@@ -24,8 +24,7 @@ Okdata CLI provides a unified interface to data services for Oslo Origo teams.
 
 * [Install](doc/install.md)
 * [Configuration](doc/configuration.md)
-* [Datasets](doc/datasets.md)
-* [Permissions](doc/permissions.md)
-* [Pipelines](doc/pipelines.md)
 * [Public registers](doc/pubreg.md)
 * [Teams](doc/teams.md)
+* [Datasets](doc/datasets.md)
+* [Permissions](doc/permissions.md)

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/README.md

@@ -4,8 +4,7 @@ Okdata CLI provides a unified interface to data services for Oslo Origo teams.
 
 * [Install](doc/install.md)
 * [Configuration](doc/configuration.md)
-* [Datasets](doc/datasets.md)
-* [Permissions](doc/permissions.md)
-* [Pipelines](doc/pipelines.md)
 * [Public registers](doc/pubreg.md)
 * [Teams](doc/teams.md)
+* [Datasets](doc/datasets.md)
+* [Permissions](doc/permissions.md)

okdata-cli-2.0.1/okdata/cli/__init__.py

@@ -0,0 +1 @@
+MAINTAINER = "Dataspeilet"

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata/cli/__main__.py

@@ -5,10 +5,10 @@ from keycloak.exceptions import KeycloakGetError
 from okdata.sdk.exceptions import ApiAuthenticateError
 from requests.exceptions import RequestException
 
+from okdata.cli import MAINTAINER
 from okdata.cli.command import BaseCommand
 from okdata.cli.commands.datasets import DatasetsCommand
 from okdata.cli.commands.permissions import PermissionsCommand
-from okdata.cli.commands.pipelines import Pipelines
 from okdata.cli.commands.pubreg import PubregCommand
 from okdata.cli.commands.status import StatusCommand
 from okdata.cli.commands.teams.teams import TeamsCommand
@@ -33,7 +33,7 @@ def main():
             else:
                 instance.print(
                     "A server error occurred. Please try again, or contact "
-                    "Datapatruljen if the problem persists.",
+                    f"{MAINTAINER} if the problem persists.",
                 )
         except ApiAuthenticateError:
             instance.print(
@@ -69,7 +69,6 @@ def get_command_class(argv):
     commands = {
         "datasets": DatasetsCommand,
         "permissions": PermissionsCommand,
-        "pipelines": Pipelines,
         "pubreg": PubregCommand,
         "status": StatusCommand,
         "teams": TeamsCommand,

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata/cli/command.py

@@ -13,7 +13,7 @@ BASE_COMMAND_OPTIONS = """
 
 
 class BaseCommand:
-    version = "1.6.0"
+    version = "2.0.1"
     # TODO: Can use `importlib` in Python 3.8 and up instead of hard coding the
     #       version here:
     #
@@ -24,7 +24,6 @@ class BaseCommand:
 usage:
   okdata datasets [options]
   okdata permissions [options]
-  okdata pipelines [options]
   okdata pubreg [options]
   okdata status [options]
   okdata teams [options]
@@ -33,7 +32,6 @@ usage:
 Commands available:
   datasets
   permissions
-  pipelines
   pubreg
   status
   teams
@@ -125,7 +123,7 @@ Options:{BASE_COMMAND_OPTIONS}
         print(self.__doc__, end="")
 
     def print_error_response(self, response_body):
-        if type(response_body) != dict:
+        if not isinstance(response_body, dict):
             print(response_body)
             return
 
@@ -135,19 +133,29 @@ Options:{BASE_COMMAND_OPTIONS}
             print(json.dumps(response_body))
         else:
             try:
-                feedback = generate_error_feedback(
-                    message=response_body["message"],
-                    errors=response_body.get("errors", None),
+                print(
+                    _format_error_message(
+                        response_body["message"], response_body.get("errors")
+                    )
                 )
-                print(feedback)
             except KeyError:
                 self.log.debug("Got unexpected response body from api.")
                 print(response_body)
 
 
-def generate_error_feedback(message, errors=None):
-    feedback = f"An error occurred: {message}"
-    if errors:
-        feedback += f"\nCause:\n\t{errors}"
+def _format_error_message(message, errors=None):
+    msg = f"An error occurred: {message}"
+    sep = "\n - "
 
-    return f"{feedback}"
+    if isinstance(errors, list):
+        msg += "\nCause{}:{}{}".format(
+            "s" if len(errors) > 1 else "",
+            sep,
+            sep.join(
+                err.get("msg", "") if isinstance(err, dict) else err for err in errors
+            ),
+        )
+    elif errors:
+        msg += f"\nCause:{sep}{errors}"
+
+    return msg

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata/cli/commands/datasets/datasets.py

@@ -246,8 +246,7 @@ Options:{BASE_COMMAND_OPTIONS}
         except HTTPError as he:
             if he.response.status_code == 404:
                 return self._auto_create_edition(dataset_id, version)
-            else:
-                raise he
+            raise
 
     # #################################### #
     # Distribution
@@ -351,7 +350,16 @@ Options:{BASE_COMMAND_OPTIONS}
             "trace_id": res["trace_id"],
         }
         out.add_row(data)
-        self.print(f"Uploaded file to dataset: {dataset_id}", out)
+        self.print(
+            "\n".join(
+                [
+                    f"Uploaded file to dataset: {dataset_id}",
+                    str(out),
+                    "\nYou can check the data processing status by running:\n",
+                    f"  okdata status {res['trace_id']}",
+                ]
+            )
+        )
 
     def download_files(self, source, target):
         dataset_id, version, edition = self._dataset_components_from_uri(source)

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata/cli/commands/pubreg/pubreg.py

@@ -3,8 +3,8 @@ from datetime import datetime
 from operator import itemgetter
 
 from okdata.sdk.team.client import TeamClient
-from requests.exceptions import HTTPError
 
+from okdata.cli import MAINTAINER
 from okdata.cli.command import BASE_COMMAND_OPTIONS, BaseCommand
 from okdata.cli.commands.pubreg.client import PubregClient
 from okdata.cli.commands.pubreg.questions import NoClientsError, NoKeysError
@@ -72,7 +72,7 @@ Options:{BASE_COMMAND_OPTIONS}
         except NoTeamError:
             self.print(
                 "We haven't yet registered you as member of any Origo team. "
-                "Please contact Datapatruljen to get it done."
+                f"Please contact {MAINTAINER} to get it done."
             )
             return
 
@@ -88,22 +88,18 @@ Options:{BASE_COMMAND_OPTIONS}
             f"scopes {scopes}."
         )
 
-        try:
-            self.print("Creating client...")
-            response = self.pubreg_client.create_client(
-                team_id, provider_id, integration, scopes, env
-            )
-            client_name = response["client_name"]
-            self.print(
-                f"""
+        self.print("Creating client...")
+        response = self.pubreg_client.create_client(
+            team_id, provider_id, integration, scopes, env
+        )
+        client_name = response["client_name"]
+        self.print(
+            f"""
 Done! Created a new client '{client_name}'.
 You may now go ahead and create a key for it by running:
 
   okdata pubreg create-key"""
-            )
-        except HTTPError as e:
-            message = e.response.json()["message"]
-            self.print(f"Something went wrong: {message}")
+        )
 
     def list_clients(self):
         config = list_clients_wizard()
@@ -135,34 +131,28 @@ You may now go ahead and create a key for it by running:
             ),
         )
 
-        try:
-            self.print(f"Deleting client '{client_name}' [{env}]...")
-            res = self.pubreg_client.delete_client(
-                env, client_id, aws_account, aws_region
-            )
-            deleted_ssm_params = res["deleted_ssm_params"]
-            self.print("\nDone! The client is deleted and will no longer work.")
-
-            if delete_from_aws:
-                if deleted_ssm_params:
-                    self.print(
-                        "\nThe following {} deleted from SSM:".format(
-                            "parameter was"
-                            if len(deleted_ssm_params) == 1
-                            else "parameters were"
-                        )
-                    )
-                    for param in deleted_ssm_params:
-                        self.print(f"- {param}")
-                else:
-                    self.print(
-                        "However the key secrets couldn't be deleted from SSM "
-                        "as requested."
-                    )
+        self.print(f"Deleting client '{client_name}' [{env}]...")
+        res = self.pubreg_client.delete_client(env, client_id, aws_account, aws_region)
+        deleted_ssm_params = res["deleted_ssm_params"]
 
-        except HTTPError as e:
-            message = e.response.json()["message"]
-            self.print(f"Something went wrong: {message}")
+        self.print("\nDone! The client is deleted and will no longer work.")
+
+        if delete_from_aws:
+            if deleted_ssm_params:
+                self.print(
+                    "\nThe following {} deleted from SSM:".format(
+                        "parameter was"
+                        if len(deleted_ssm_params) == 1
+                        else "parameters were"
+                    )
+                )
+                for param in deleted_ssm_params:
+                    self.print(f"- {param}")
+            else:
+                self.print(
+                    "However the key secrets couldn't be deleted from SSM as "
+                    "requested."
+                )
 
     def _handle_new_key_aws(self, key, enabled_auto_rotate):
         params = key.get("ssm_params")
@@ -186,7 +176,7 @@ You may now go ahead and create a key for it by running:
             self.print(
                 "The key was created, but it appears that the relevant "
                 "parameters weren't added to SSM. This should not happen, "
-                "please contact Datapatruljen!"
+                f"please contact {MAINTAINER}!"
             )
 
     def _handle_new_key_local(self, key, client_name, env):
@@ -251,14 +241,9 @@ You may now go ahead and create a key for it by running:
 
         self.print("Creating key for '{}' [{}]...".format(client_name, env))
 
-        try:
-            key = self.pubreg_client.create_key(
-                env, client_id, aws_account, aws_region, enable_auto_rotate
-            )
-        except HTTPError as e:
-            message = e.response.json()["message"]
-            self.print(f"Something went wrong: {message}")
-            return
+        key = self.pubreg_client.create_key(
+            env, client_id, aws_account, aws_region, enable_auto_rotate
+        )
 
         if key.get("ssm_params") is not None:
             self._handle_new_key_aws(key, enable_auto_rotate)
@@ -267,8 +252,7 @@ You may now go ahead and create a key for it by running:
         else:
             self.print(
                 "The key was neither added to AWS nor returned to the "
-                "client. This should not happen, please contact "
-                "Datapatruljen!"
+                f"client. This should not happen, please contact {MAINTAINER}!"
             )
 
     def _list_client_keys_single(self, client_id, client_name, env):
@@ -321,15 +305,9 @@ You may now go ahead and create a key for it by running:
             f"Will delete key '{key_id}' from '{client_name}' [{env}]."
         )
 
-        try:
-            self.print(
-                f"Deleting key '{key_id}' from '{client_name}' [{env}]...",
-            )
-            self.pubreg_client.delete_key(env, client_id, key_id)
-            self.print("Done! The key is deleted and will no longer work.")
-        except HTTPError as e:
-            message = e.response.json()["message"]
-            self.print(f"Something went wrong: {message}")
+        self.print(f"Deleting key '{key_id}' from '{client_name}' [{env}]...")
+        self.pubreg_client.delete_key(env, client_id, key_id)
+        self.print("Done! The key is deleted and will no longer work.")
 
     def audit_log(self):
         choices = audit_log_wizard(self.pubreg_client)

okdata-cli-2.0.1/okdata/cli/commands/teams/teams.py

@@ -0,0 +1,174 @@
+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.commands.teams.questions import NoTeamError
+from okdata.cli.commands.teams.util import (
+    member_representation,
+    sorted_member_list,
+)
+from okdata.cli.commands.teams.wizards import (
+    add_member_wizard,
+    edit_team_wizard,
+    list_members_wizard,
+    remove_member_wizard,
+)
+from okdata.cli.output import create_output
+
+
+class TeamsCommand(BaseCommand):
+    __doc__ = f"""Oslo :: Teams
+
+Usage:
+  okdata teams ls [--my] [options]
+  okdata teams edit [options]
+  okdata teams list-members [--my] [options]
+  okdata teams add-member [options]
+  okdata teams remove-member [options]
+
+Examples:
+  okdata teams ls
+  okdata teams ls --my
+  okdata teams edit
+  okdata teams list-members --my
+  okdata teams add-member
+  okdata teams remove-member
+
+Options:{BASE_COMMAND_OPTIONS}
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.client = TeamClient(env=self.opt("env"))
+
+    def handler(self):
+        if self.cmd("ls"):
+            self.ls(self.opt("my"))
+        if self.cmd("edit"):
+            self.edit()
+        if self.cmd("list-members"):
+            self.list_members(self.opt("my"))
+        if self.cmd("add-member"):
+            self.add_member()
+        if self.cmd("remove-member"):
+            self.remove_member()
+
+    def ls(self, my):
+        teams = self.client.get_teams(
+            include=None if my else "all", has_role="origo-team"
+        )
+        out = create_output(self.opt("format"), "teams_config.json")
+        out.add_rows(sorted(teams, key=itemgetter("name")))
+        self.print("{} teams:".format("My" if my else "All"), out)
+
+    def edit(self):
+        try:
+            config = edit_team_wizard(self.client)
+        except NoTeamError:
+            self.print(
+                "We haven't yet registered you as member of any Origo team. "
+                f"Please contact {MAINTAINER} to get it done."
+            )
+            return
+
+        if config["attribute"] == "name":
+            self.client.update_team_name(config["team_id"], config["team_name"])
+        else:
+            self.client.update_team_attribute(
+                config["team_id"], config["attribute"], config["attribute_value"]
+            )
+        self.print("Done!")
+
+    def list_members(self, my):
+        try:
+            config = list_members_wizard(self.client, my)
+            members = self.client.get_team_members(config["team_id"])
+        except NoTeamError:
+            self.print(
+                "We haven't yet registered you as member of any Origo team. "
+                f"Please contact {MAINTAINER} to get it done."
+                if my
+                else "No teams exist yet."
+            )
+            return
+
+        out = create_output(self.opt("format"), "team_members_config.json")
+
+        out.add_rows(sorted_member_list(members))
+        self.print("Team members", out)
+
+    def add_member(self):
+        try:
+            config = add_member_wizard(self.client)
+        except NoTeamError:
+            self.print(
+                "We haven't yet registered you as member of any Origo team. "
+                f"Please contact {MAINTAINER} to get it done."
+            )
+            return
+
+        user = self.client.get_user_by_username(config["username"])
+        team_members = [
+            m["username"] for m in self.client.get_team_members(config["team_id"])
+        ]
+
+        if user["username"] in team_members:
+            self.print(
+                "User {} is already a member of this team.".format(
+                    member_representation(user)
+                )
+            )
+            return
+
+        self.confirm_to_continue(
+            "Add {} to the team?".format(member_representation(user))
+        )
+
+        self.client.update_team_members(
+            config["team_id"], team_members + [user["username"]]
+        )
+        self.print("Done!")
+
+    def remove_member(self):
+        try:
+            config = remove_member_wizard(self.client)
+        except NoTeamError:
+            self.print(
+                "We haven't yet registered you as member of any Origo team. "
+                f"Please contact {MAINTAINER} to get it done."
+            )
+            return
+
+        team_members = self.client.get_team_members(config["team_id"])
+        members_to_remove, members_to_keep = [], []
+        for member in team_members:
+            if member["username"] in config["usernames"]:
+                members_to_remove.append(member)
+            else:
+                members_to_keep.append(member)
+
+        if len(members_to_keep) == 0:
+            self.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(
+                "Remove the following member{} from the team?\n - {}".format(
+                    "s" if len(members_to_remove) > 1 else "",
+                    "\n - ".join(
+                        [
+                            member_representation(m)
+                            for m in sorted_member_list(members_to_remove)
+                        ]
+                    ),
+                )
+            )
+
+        self.client.update_team_members(
+            config["team_id"], [m["username"] for m in members_to_keep]
+        )
+        self.print("Done!")

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata/cli/data/output-format/datasets_copy_file_config.json

@@ -8,7 +8,7 @@
     "key": "file"
   },
   "Uploaded": {
-    "name": "Upload status",
+    "name": "Uploaded?",
     "key": "uploaded"
   },
   "TraceID": {

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata/cli/output.py

@@ -1,4 +1,3 @@
-import inspect
 import json
 import logging
 import os
@@ -31,30 +30,6 @@ def create_output(format, configfile):
     return TableOutput(config)
 
 
-def table_config_from_schema(resource, exclude=None):
-    if exclude is None:
-        exclude = []
-
-    def _for(properties):
-        for property in properties:
-            body = properties[property]
-            if "properties" not in body:
-                yield body["title"], {"name": body["title"], "key": property}
-            else:
-                _for(body["properties"])
-
-    with open(
-        os.path.dirname(inspect.getfile(resource))
-        + f"/schemas/{resource.__resource_name__}.json",
-        "r",
-    ) as f:
-        schema = json.loads(f.read())
-        config = {
-            key: body for key, body in _for(schema["properties"]) if key not in exclude
-        }
-        return TableOutput(config)
-
-
 class TableOutput(PrettyTable):
     def __init__(self, config):
         self.config = config

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: okdata-cli
-Version: 1.6.0
+Version: 2.0.1
 Summary: CLI for services provided by Oslo Origo
 Home-page: https://github.com/oslokommune/okdata-cli/
 Author: Oslo Origo
@@ -24,8 +24,7 @@ Okdata CLI provides a unified interface to data services for Oslo Origo teams.
 
 * [Install](doc/install.md)
 * [Configuration](doc/configuration.md)
-* [Datasets](doc/datasets.md)
-* [Permissions](doc/permissions.md)
-* [Pipelines](doc/pipelines.md)
 * [Public registers](doc/pubreg.md)
 * [Teams](doc/teams.md)
+* [Datasets](doc/datasets.md)
+* [Permissions](doc/permissions.md)

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/okdata_cli.egg-info/SOURCES.txt

@@ -18,11 +18,6 @@ okdata/cli/commands/datasets/datasets.py
 okdata/cli/commands/datasets/questions.py
 okdata/cli/commands/datasets/validators.py
 okdata/cli/commands/datasets/wizards.py
-okdata/cli/commands/pipelines/__init__.py
-okdata/cli/commands/pipelines/inputs.py
-okdata/cli/commands/pipelines/instances.py
-okdata/cli/commands/pipelines/pipelines.py
-okdata/cli/commands/pipelines/schemas.py
 okdata/cli/commands/pubreg/__init__.py
 okdata/cli/commands/pubreg/client.py
 okdata/cli/commands/pubreg/pubreg.py
@@ -42,10 +37,6 @@ okdata/cli/data/output-format/datasets_dataset_version_edition_distributions_con
 okdata/cli/data/output-format/datasets_dataset_versions_config.json
 okdata/cli/data/output-format/my_permissions_config.json
 okdata/cli/data/output-format/permissions_config.json
-okdata/cli/data/output-format/pipelines_config.json
-okdata/cli/data/output-format/pipelines_instances_config.json
-okdata/cli/data/output-format/pipelines_instances_inputs_config.json
-okdata/cli/data/output-format/pipelines_instances_schemas_config.json
 okdata/cli/data/output-format/pubreg_audit_log_config.json
 okdata/cli/data/output-format/pubreg_clients_config.json
 okdata/cli/data/output-format/pubreg_multiple_client_keys_config.json

{okdata-cli-1.6.0 → okdata-cli-2.0.1}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="okdata-cli",
-    version="1.6.0",
+    version="2.0.1",
     author="Oslo Origo",
     author_email="dataplattform@oslo.kommune.no",
     description="CLI for services provided by Oslo Origo",

okdata-cli-1.6.0/okdata/cli/commands/pipelines/__init__.py

@@ -1,3 +0,0 @@
-from .pipelines import Pipelines
-
-__all__ = ["Pipelines"]

okdata-cli-1.6.0/okdata/cli/commands/pipelines/inputs.py

@@ -1,66 +0,0 @@
-import json
-
-from okdata.cli.command import BaseCommand
-from okdata.cli.output import create_output
-
-
-class PipelinesInputsLs(BaseCommand):
-    """
-    usage:
-      okdata pipelines inputs ls <pipeline-instance> [options]
-
-    options:
-      -d --debug
-      --format=<format>
-    """
-
-    def handler(self):
-        out = create_output(
-            self.opt("format"), "pipelines_instances_inputs_config.json"
-        )
-        data = self.sdk.get_pipeline_inputs(self.arg("pipeline-instance"))
-        data = list(map(lambda x: x.__dict__, data))
-        out.add_rows(data)
-        self.print("Available pipepline inputs", out)
-
-
-class PipelinesInputsCreate(BaseCommand):
-    """
-    usage:
-      okdata pipelines inputs create - [options]
-      okdata pipelines inputs create <file> [options]
-
-    options:
-      -d --debug
-      --format=<format>
-    """
-
-    def handler(self):
-        content = self.handle_input()
-        data = json.loads(content)
-        self.sdk.create_pipeline_input(data)
-        self.print(f"Created input with dataset URI: {data['datasetUri']}", data)
-
-
-class PipelinesInputs(BaseCommand):
-    """
-    usage:
-      okdata pipelines inputs ls <pipeline-instance> [options]
-      okdata pipelines inputs create (<file> | -) [options]
-
-    options:
-      -d --debug
-      --format=<format>
-    """
-
-    def __init__(self, sdk):
-        super().__init__(sdk)
-        self.sub_commands = [PipelinesInputsLs, PipelinesInputsCreate]
-
-    def handler(self):
-        if self.opt("help"):
-            return self.help()
-        schema = self.sdk.get_schema(self.opt("id"))
-        schema.schema = json.loads(schema.schema)
-        self.pretty_json(schema.__dict__)
-        return None