okdata-cli 5.0.1__tar.gz → 6.1.0__tar.gz

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2024 Oslo Origo
+Copyright (c) 2019-2026 Oslo kommune
 
 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-5.0.1 → okdata_cli-6.1.0}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: okdata-cli
-Version: 5.0.1
+Version: 6.1.0
 Summary: CLI for services provided by Oslo Origo
 Home-page: https://github.com/oslokommune/okdata-cli/
 Author: Oslo Origo
 Author-email: dataspeilet@oslo.kommune.no
 License: MIT
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: docopt
-Requires-Dist: okdata-sdk<4,>=3.4
+Requires-Dist: okdata-sdk<5,>=4.1
 Requires-Dist: PrettyTable
 Requires-Dist: questionary<2.0.0,>=1.10.0
 Requires-Dist: prompt-toolkit<3.0.52

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/__main__.py

@@ -4,7 +4,7 @@ import sys
 
 from keycloak.exceptions import KeycloakGetError, KeycloakPostError
 from okdata.sdk.exceptions import ApiAuthenticateError
-from requests.exceptions import RequestException
+from requests.exceptions import ConnectTimeout, RequestException
 
 from okdata.cli import MAINTAINER
 from okdata.cli.command import BaseCommand
@@ -37,6 +37,11 @@ def main():
             # Flush output here to force SIGPIPE to be triggered while inside
             # this try block.
             sys.stdout.flush()
+        except ConnectTimeout as e:
+            instance.print(
+                f"Connection to '{e.request.url}' timed out. Please try again, "
+                f"or contact {MAINTAINER} if the problem persists.",
+            )
         except RequestException as e:
             if hasattr(e.response, "json"):
                 instance.print_error_response(e.response.json())

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/datasets/datasets.py

@@ -1,7 +1,7 @@
 import sys
 
 from okdata.sdk.data.dataset import Dataset
-from okdata.sdk.data.download import Download
+from okdata.sdk.data.download import Download, DownloadURLAssertionError
 from okdata.sdk.data.upload import Upload
 from requests.exceptions import HTTPError
 
@@ -123,7 +123,7 @@ Options:{BASE_COMMAND_OPTIONS}
             return
 
         config = (
-            "datasets_config_verbose"
+            "datasets_config_verbose.json"
             if self.opt("verbose")
             else "datasets_dataset_config.json"
         )
@@ -421,9 +421,14 @@ Options:{BASE_COMMAND_OPTIONS}
     def download_files(self, source, target):
         download = Download(env=self.opt("env"))
         dataset_id, version, edition = self._dataset_components_from_uri(source)
-        downloaded_files = download.download(
-            dataset_id, version, edition, resolve_output_filepath(target)
-        )
+
+        try:
+            downloaded_files = download.download(
+                dataset_id, version, edition, resolve_output_filepath(target)
+            )
+        except DownloadURLAssertionError as e:
+            sys.exit(e)
+
         self.log.info(f"Download returned: {downloaded_files}")
         out = create_output(self.opt("format"), "datasets_copy_file_config_2.json")
         out.output_singular_object = True

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/datasets/questions.py

@@ -63,7 +63,7 @@ def qs_create_dataset():
             "message": "Tilgangsnivå",
             "choices": [
                 Choice("Eksplisitt tilgangskontroll", "non-public"),
-                Choice("Internt til Origo", "restricted"),
+                Choice("Internt til kommunen", "restricted"),
                 Choice("Offentlig", "public"),
             ],
         },

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/pubs/clients.py

@@ -13,13 +13,16 @@ class PubsClient(SDK):
             "-dev" if self.config.config["env"] == "dev" else ""
         )
 
-    def create_maskinporten_client(self, team_id, provider, integration, scopes, env):
+    def create_maskinporten_client(
+        self, team_id, provider, integration, scopes, org, env
+    ):
         data = {
             "client_type": "maskinporten",
             "team_id": team_id,
             "provider": provider,
             "integration": integration,
             "scopes": scopes,
+            "org": org,
             "env": env,
         }
         log.info(f"Creating Maskinporten client with payload: {data}")
@@ -33,6 +36,7 @@ class PubsClient(SDK):
         frontchannel_logout_uri,
         redirect_uris,
         post_logout_redirect_uris,
+        org,
         env,
     ):
         data = {
@@ -44,17 +48,22 @@ class PubsClient(SDK):
             "frontchannel_logout_uri": frontchannel_logout_uri,
             "redirect_uris": redirect_uris,
             "post_logout_redirect_uris": post_logout_redirect_uris,
+            "org": org,
             "env": env,
         }
         log.info(f"Creating ID-porten client with payload: {data}")
         return self.post(f"{self.api_url}/clients", data=data).json()
 
-    def get_clients(self, env):
-        url = f"{self.api_url}/clients/{env}"
+    def get_clients(self, env, org=None):
+        url = "{}/clients/{}{}".format(
+            self.api_url,
+            env,
+            f"?org={org}" if org else "",
+        )
         log.info(f"Listing clients from: {url}")
         return self.get(url).json()
 
-    def delete_client(self, env, client_id, aws_account, aws_region):
+    def delete_client(self, org, env, client_id, aws_account, aws_region):
         url = f"{self.api_url}/clients/{env}/{client_id}/delete"
         log.info(f"Deleting client for: {url}")
         return self.post(
@@ -62,11 +71,13 @@ class PubsClient(SDK):
             data={
                 "aws_account": aws_account,
                 "aws_region": aws_region,
+                "org": org,
             },
         ).json()
 
     def create_key(
         self,
+        org,
         env,
         client_id,
         aws_account,
@@ -81,6 +92,7 @@ class PubsClient(SDK):
                 "destination_aws_account": aws_account,
                 "destination_aws_region": aws_region,
                 "enable_auto_rotate": enable_auto_rotate,
+                "org": org,
             },
         ).json()
 

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/pubs/pubs.py

@@ -84,7 +84,7 @@ Options:{BASE_COMMAND_OPTIONS}
             )
         except NoTeamError:
             self.print(
-                "We haven't yet registered you as member of any Origo team. "
+                "You are not yet registered as a member of a team. "
                 f"Please contact {MAINTAINER} to get it done."
             )
             return
@@ -94,6 +94,7 @@ Options:{BASE_COMMAND_OPTIONS}
         provider_id = config["provider_id"]
         integration = config["integration"]
         scopes = config["scopes"]
+        org = config["org"]
         env = config["env"]
 
         confirm_to_continue(
@@ -108,7 +109,7 @@ Options:{BASE_COMMAND_OPTIONS}
         self.print("Creating client...")
         if client_type_id == "maskinporten":
             response = self.pubs_client.create_maskinporten_client(
-                team_id, provider_id, integration, scopes, env
+                team_id, provider_id, integration, scopes, org, env
             )
         else:
             response = self.pubs_client.create_idporten_client(
@@ -118,27 +119,34 @@ Options:{BASE_COMMAND_OPTIONS}
                 config["frontchannel_logout_uri"],
                 config["redirect_uris"],
                 config["post_logout_redirect_uris"],
+                org,
                 env,
             )
         client_name = response["client_name"]
-        self.print(
-            f"""
+        self.print(f"""
 Done! Created a new client '{client_name}'.
 You may now go ahead and create a key for it by running:
 
-  okdata pubs create-key"""
-        )
+  okdata pubs create-key""")
 
     def list_clients(self):
         config = list_clients_wizard()
+        org = config["org"]
         env = config["env"]
-        clients = self.pubs_client.get_clients(env)
+
+        clients = self.pubs_client.get_clients(env, org)
         out = create_output(self.opt("format"), "pubs_clients_config.json")
         out.add_rows(sorted(clients, key=itemgetter("client_name")))
         self.print(f"Clients in {env}:", out)
 
     def delete_client(self):
-        choices = delete_client_wizard(self.pubs_client)
+        try:
+            choices = delete_client_wizard(self.pubs_client)
+        except NoClientsError:
+            self.print("No clients in the given environment.")
+            return
+
+        org = choices["org"]
         env = choices["env"]
         client_id = choices["client_id"]
         client_name = choices["client_name"]
@@ -162,7 +170,9 @@ You may now go ahead and create a key for it by running:
         )
 
         self.print(f"Deleting client '{client_name}' [{env}]...")
-        res = self.pubs_client.delete_client(env, client_id, aws_account, aws_region)
+        res = self.pubs_client.delete_client(
+            org, 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.")
@@ -209,8 +219,8 @@ You may now go ahead and create a key for it by running:
                 f"please contact {MAINTAINER}!"
             )
 
-    def _handle_new_key_local(self, key, client_name, env):
-        outfile = f"{client_name}-{env}-{key['kid']}.p12"
+    def _handle_new_key_local(self, key, client_id, env):
+        outfile = f"{client_id}-{env}-{key['kid']}.p12"
 
         with open(outfile, "wb") as f:
             f.write(base64.b64decode(key["keystore"]))
@@ -241,6 +251,7 @@ You may now go ahead and create a key for it by running:
             )
             return
 
+        org = config["org"]
         env = config["env"]
         client_id = config["client_id"]
         client_name = config["client_name"]
@@ -276,13 +287,13 @@ You may now go ahead and create a key for it by running:
         self.print("Creating key for '{}' [{}]...".format(client_name, env))
 
         key = self.pubs_client.create_key(
-            env, client_id, aws_account, aws_region, enable_auto_rotate
+            org, 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)
         elif key.get("keystore") and key.get("key_password"):
-            self._handle_new_key_local(key, client_name, env)
+            self._handle_new_key_local(key, client_id, env)
         else:
             self.print(
                 "The key was neither added to AWS nor returned to the "
@@ -313,7 +324,12 @@ You may now go ahead and create a key for it by running:
         self.print(f"All client keys [{env}]:", out)
 
     def list_client_keys(self):
-        choices = list_keys_wizard(self.pubs_client)
+        try:
+            choices = list_keys_wizard(self.pubs_client)
+        except NoClientsError:
+            self.print("No clients in the given environment.")
+            return
+
         env = choices["env"]
 
         if "clients" in choices:
@@ -326,6 +342,9 @@ You may now go ahead and create a key for it by running:
     def delete_client_key(self):
         try:
             choices = delete_key_wizard(self.pubs_client)
+        except NoClientsError:
+            self.print("No clients in the given environment.")
+            return
         except NoKeysError:
             self.print("The selected client doesn't have any keys.")
             return
@@ -342,7 +361,12 @@ You may now go ahead and create a key for it by running:
         self.print("Done! The key is deleted and will no longer work.")
 
     def audit_log(self):
-        choices = audit_log_wizard(self.pubs_client)
+        try:
+            choices = audit_log_wizard(self.pubs_client)
+        except NoClientsError:
+            self.print("No clients in the given environment.")
+            return
+
         env = choices["env"]
         client_id = choices["client_id"]
         client_name = choices["client_name"]

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/pubs/questions.py

@@ -15,6 +15,10 @@ client_types = {
     "maskinporten": "Maskinporten",
 }
 
+_organizations = [
+    "dig",
+]
+
 _environments = [
     "test",
     "prod",
@@ -35,6 +39,16 @@ class NoKeysError(Exception):
     pass
 
 
+def q_org():
+    return {
+        **required_style,
+        "type": "select",
+        "name": "org",
+        "message": "Organization",
+        "choices": _organizations,
+    }
+
+
 def q_env():
     return {
         **required_style,
@@ -143,8 +157,8 @@ def q_client_uri():
 
 
 def q_client(pubs_client, allow_all=False):
-    def _client_choices(env):
-        clients = pubs_client.get_clients(env)
+    def _client_choices(org, env):
+        clients = pubs_client.get_clients(env, org)
 
         if not clients:
             raise NoClientsError
@@ -165,7 +179,7 @@ def q_client(pubs_client, allow_all=False):
         "type": "select",
         "name": "client",
         "message": "Client",
-        "choices": lambda x: _client_choices(x["env"]),
+        "choices": lambda x: _client_choices(x["org"], x["env"]),
     }
 
 

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/pubs/wizards.py

@@ -11,6 +11,7 @@ from okdata.cli.commands.pubs.questions import (
     q_integration,
     q_key,
     q_key_destination,
+    q_org,
     q_post_logout_redirect_uris,
     q_provider,
     q_redirect_uris,
@@ -22,6 +23,7 @@ from okdata.cli.commands.wizard import run_questionnaire
 
 def create_client_wizard(team_client, providers, scopes):
     choices = run_questionnaire(
+        q_org(),
         q_env(),
         q_team(team_client),
         q_client_type(),
@@ -34,6 +36,7 @@ def create_client_wizard(team_client, providers, scopes):
         q_client_uri(),
     )
     return {
+        "org": choices["org"],
         "env": choices["env"],
         "team_id": choices.get("team_id"),
         "client_type_id": choices["client_type_id"],
@@ -48,12 +51,16 @@ def create_client_wizard(team_client, providers, scopes):
 
 
 def list_clients_wizard():
-    choices = run_questionnaire(q_env())
-    return {"env": choices["env"]}
+    choices = run_questionnaire(q_org(), q_env())
+    return {
+        "org": choices["org"],
+        "env": choices["env"],
+    }
 
 
 def delete_client_wizard(pubs_client):
     choices = run_questionnaire(
+        q_org(),
         q_env(),
         q_client(pubs_client),
         q_delete_from_aws(),
@@ -61,6 +68,7 @@ def delete_client_wizard(pubs_client):
         q_aws_region(),
     )
     return {
+        "org": choices["org"],
         "env": choices["env"],
         "client_id": choices["client"]["id"],
         "client_name": choices["client"]["name"],
@@ -72,6 +80,7 @@ def delete_client_wizard(pubs_client):
 
 def create_key_wizard(pubs_client):
     choices = run_questionnaire(
+        q_org(),
         q_env(),
         q_client(pubs_client),
         q_key_destination(),
@@ -80,6 +89,7 @@ def create_key_wizard(pubs_client):
         q_enable_auto_rotate(),
     )
     return {
+        "org": choices["org"],
         "env": choices["env"],
         "client_id": choices["client"]["id"],
         "client_name": choices["client"]["name"],
@@ -91,8 +101,13 @@ def create_key_wizard(pubs_client):
 
 
 def list_keys_wizard(pubs_client):
-    choices = run_questionnaire(q_env(), q_client(pubs_client, True))
+    choices = run_questionnaire(
+        q_org(),
+        q_env(),
+        q_client(pubs_client, True),
+    )
     return {
+        "org": choices["org"],
         "env": choices["env"],
         **(
             {
@@ -109,11 +124,13 @@ def list_keys_wizard(pubs_client):
 
 def delete_key_wizard(pubs_client):
     choices = run_questionnaire(
+        q_org(),
         q_env(),
         q_client(pubs_client),
         q_key(pubs_client),
     )
     return {
+        "org": choices["org"],
         "env": choices["env"],
         "client_id": choices["client"]["id"],
         "client_name": choices["client"]["name"],
@@ -122,8 +139,13 @@ def delete_key_wizard(pubs_client):
 
 
 def audit_log_wizard(pubs_client):
-    choices = run_questionnaire(q_env(), q_client(pubs_client))
+    choices = run_questionnaire(
+        q_org(),
+        q_env(),
+        q_client(pubs_client),
+    )
     return {
+        "org": choices["org"],
         "env": choices["env"],
         "client_id": choices["client"]["id"],
         "client_name": choices["client"]["name"],

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/teams/teams.py

@@ -68,7 +68,7 @@ Options:{BASE_COMMAND_OPTIONS}
             config = edit_team_wizard(self.client)
         except NoTeamError:
             self.print(
-                "We haven't yet registered you as member of any Origo team. "
+                "You are not yet registered as a member of a team. "
                 f"Please contact {MAINTAINER} to get it done."
             )
             return
@@ -87,7 +87,7 @@ Options:{BASE_COMMAND_OPTIONS}
             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. "
+                "You are not yet registered as a member of a team. "
                 f"Please contact {MAINTAINER} to get it done."
                 if my
                 else "No teams exist yet."
@@ -104,7 +104,7 @@ Options:{BASE_COMMAND_OPTIONS}
             config = add_member_wizard(self.client)
         except NoTeamError:
             self.print(
-                "We haven't yet registered you as member of any Origo team. "
+                "You are not yet registered as a member of a team. "
                 f"Please contact {MAINTAINER} to get it done."
             )
             return
@@ -134,7 +134,7 @@ Options:{BASE_COMMAND_OPTIONS}
             config = remove_member_wizard(self.client)
         except NoTeamError:
             self.print(
-                "We haven't yet registered you as member of any Origo team. "
+                "You are not yet registered as a member of a team. "
                 f"Please contact {MAINTAINER} to get it done."
             )
             return

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata/cli/commands/validators.py

@@ -67,9 +67,9 @@ class IntegrationValidator(Validator):
             raise ValidationError(
                 message="Too long!", cursor_position=len(document.text)
             )
-        if not re.fullmatch("[0-9a-z-]+", document.text):
+        if not re.fullmatch("[0-9a-zA-Z -]+", document.text):
             raise ValidationError(
-                message='Only lowercase letters, numbers and "-", please',
+                message='Only letters, numbers, spaces and "-", please',
                 cursor_position=len(document.text),
             )
 

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata_cli.egg-info/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: okdata-cli
-Version: 5.0.1
+Version: 6.1.0
 Summary: CLI for services provided by Oslo Origo
 Home-page: https://github.com/oslokommune/okdata-cli/
 Author: Oslo Origo
 Author-email: dataspeilet@oslo.kommune.no
 License: MIT
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: docopt
-Requires-Dist: okdata-sdk<4,>=3.4
+Requires-Dist: okdata-sdk<5,>=4.1
 Requires-Dist: PrettyTable
 Requires-Dist: questionary<2.0.0,>=1.10.0
 Requires-Dist: prompt-toolkit<3.0.52

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/okdata_cli.egg-info/requires.txt

@@ -1,5 +1,5 @@
 docopt
-okdata-sdk<4,>=3.4
+okdata-sdk<5,>=4.1
 PrettyTable
 questionary<2.0.0,>=1.10.0
 prompt-toolkit<3.0.52

{okdata_cli-5.0.1 → okdata_cli-6.1.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="okdata-cli",
-    version="5.0.1",
+    version="6.1.0",
     author="Oslo Origo",
     author_email="dataspeilet@oslo.kommune.no",
     description="CLI for services provided by Oslo Origo",
@@ -24,7 +24,7 @@ setuptools.setup(
     },
     install_requires=[
         "docopt",
-        "okdata-sdk>=3.4,<4",
+        "okdata-sdk>=4.1,<5",
         "PrettyTable",
         # TODO: Upgrade to questionary 2.x.
         "questionary>=1.10.0,<2.0.0",
@@ -37,13 +37,13 @@ setuptools.setup(
     entry_points={"console_scripts": ["okdata=okdata.cli.__main__:main"]},
     classifiers=[
         "Development Status :: 5 - Production/Stable",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
-    python_requires=">=3.9",
+    python_requires=">=3.10",
 )