cmem-cmemc 23.1.3__tar.gz → 23.3.0__tar.gz

{cmem_cmemc-23.1.3 → cmem_cmemc-23.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cmem-cmemc
-Version: 23.1.3
+Version: 23.3.0
 Summary: Command line client for eccenca Corporate Memory
 Home-page: https://eccenca.com/go/cmemc
 License: Apache 2.0
@@ -17,16 +17,16 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Database
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Utilities
 Requires-Dist: beautifulsoup4 (>=4.12.2,<5.0.0)
 Requires-Dist: certifi (>=2023.5.7)
-Requires-Dist: click (==7.1.2)
+Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: click-didyoumean (>=0.3.0,<0.4.0)
 Requires-Dist: click-help-colors (>=0.9.1,<0.10.0)
-Requires-Dist: cmem-cmempy (==23.1.1)
+Requires-Dist: cmem-cmempy (==23.3.0)
 Requires-Dist: configparser (>=5.3.0,<6.0.0)
 Requires-Dist: jinja2 (>=3.1.2,<4.0.0)
 Requires-Dist: natsort (>=8.3.1,<9.0.0)
@@ -49,11 +49,9 @@ cmemc is the official command line client for [eccenca Corporate Memory](https:/
 
 In order to install the cmemc, run:
 
-    pip install cmem-cmemc
-
-You may consider installing cmemc only for the current user:
+    pipx install cmem-cmemc
 
-    pip install cmem-cmemc --user
+Of course you can install cmemc also with pip, but we recommend [pipx](https://pypa.github.io/pipx/) for normal desktop usage.
 
 ## Configuration and Usage
 

{cmem_cmemc-23.1.3 → cmem_cmemc-23.3.0}/README-public.md

@@ -6,11 +6,9 @@ cmemc is the official command line client for [eccenca Corporate Memory](https:/
 
 In order to install the cmemc, run:
 
-    pip install cmem-cmemc
+    pipx install cmem-cmemc
 
-You may consider installing cmemc only for the current user:
-
-    pip install cmem-cmemc --user
+Of course you can install cmemc also with pip, but we recommend [pipx](https://pypa.github.io/pipx/) for normal desktop usage.
 
 ## Configuration and Usage
 

{cmem_cmemc-23.1.3 → cmem_cmemc-23.3.0}/cmem/cmemc/cli/__init__.py

@@ -1,5 +1,5 @@
 """The main command line interface."""
-
+from importlib.resources import open_text
 import os
 from subprocess import CalledProcessError  # nosec
 import sys
@@ -38,6 +38,12 @@ from cmem.cmemc.cli.commands import CmemcGroup
 
 CMEMC_VERSION = get_version()
 
+# this will output a custom zsh completion function
+if os.environ.get("_CMEMC_COMPLETE", "") == "zsh_source":
+    with open_text("cmem.cmemc.cli", "_cmemc.zsh") as zsh_output:
+        print(zsh_output.read())
+    sys.exit(0)
+
 version = sys.version_info
 PYTHON_VERSION = f"{version.major}.{version.minor}.{version.micro}"
 PYTHON_EXPECTED = "3.11"
@@ -65,12 +71,12 @@ CONTEXT_SETTINGS = {
 @click.option(
     '-c', '--connection',
     type=click.STRING,
-    autocompletion=completion.connections,
+    shell_complete=completion.connections,
     help='Use a specific connection from the config file.'
 )
 @click.option(
     '--config-file',
-    autocompletion=completion.ini_files,
+    shell_complete=completion.ini_files,
     type=click.Path(
         readable=True,
         allow_dash=False,

cmem_cmemc-23.3.0/cmem/cmemc/cli/_cmemc.zsh

@@ -0,0 +1,44 @@
+#compdef cmemc
+
+_cmemc_completion() {
+    local -a completions
+    local -a completions_with_descriptions
+    local -a response
+    (( ! $+commands[cmemc] )) && return 1
+
+    response=("${(@f)$(env COMP_WORDS="${words[*]}" COMP_CWORD=$((CURRENT-1)) _CMEMC_COMPLETE=zsh_complete cmemc)}")
+
+    for type key descr in ${response}; do
+        if [[ "$type" == "plain" ]]; then
+            if [[ "$descr" == "_" ]]; then
+                completions+=("$key")
+            else
+                completions_with_descriptions+=("$key":"$descr")
+            fi
+        elif [[ "$type" == "dir" ]]; then
+            _path_files -/
+        elif [[ "$type" == "file" ]]; then
+            _path_files -f
+        fi
+    done
+
+    if [ -n "$completions_with_descriptions" ]; then
+        _describe -V unsorted completions_with_descriptions -U
+    fi
+
+    if [ -n "$completions" ]; then
+        compadd -U -V unsorted -a completions
+    fi
+    # Other than the standard click completion function, we re-added this line
+    # in order to have working completions for task IDs
+    compstate[insert]="automenu"
+}
+
+if [[ $zsh_eval_context[-1] == loadautofunc ]]; then
+    # autoload from fpath, call function directly
+    _cmemc_completion "$@"
+else
+    # eval/source/. command, register function for later
+    compdef _cmemc_completion cmemc
+fi
+

{cmem_cmemc-23.1.3 → cmem_cmemc-23.3.0}/cmem/cmemc/cli/commands/__init__.py

@@ -29,6 +29,7 @@ class CmemcGroup(HelpColorsGroup, DYMGroup):
                 "showcase": COLOR_FOR_WRITING_COMMANDS,
                 "delete": COLOR_FOR_WRITING_COMMANDS,
                 "password": COLOR_FOR_WRITING_COMMANDS,
+                "secret": COLOR_FOR_WRITING_COMMANDS,
                 "upload": COLOR_FOR_WRITING_COMMANDS,
                 "import": COLOR_FOR_WRITING_COMMANDS,
                 "create": COLOR_FOR_WRITING_COMMANDS,
@@ -59,6 +60,8 @@ class CmemcGroup(HelpColorsGroup, DYMGroup):
                 "python": COLOR_FOR_COMMAND_GROUPS,
                 "cache": COLOR_FOR_COMMAND_GROUPS,
                 "resource": COLOR_FOR_COMMAND_GROUPS,
+                "client": COLOR_FOR_COMMAND_GROUPS,
+                "variable": COLOR_FOR_COMMAND_GROUPS,
             }
         )
         super().__init__(*args, **kwargs)

{cmem_cmemc-23.1.3 → cmem_cmemc-23.3.0}/cmem/cmemc/cli/commands/admin.py

@@ -4,6 +4,7 @@ import click
 import jwt
 
 from cmem.cmemc.cli import completion
+from cmem.cmemc.cli.commands.client import client
 from cmem.cmemc.cli.commands.user import user
 from cmem.cmemc.cli.context import ApplicationContext
 from cmem.cmemc.cli.utils import struct_to_table
@@ -20,7 +21,7 @@ from cmem.cmempy.health import get_complete_status_info
 @click.command(cls=CmemcCommand, name="status")
 @click.option(
     "--key", "key",
-    autocompletion=completion.status_keys,
+    shell_complete=completion.status_keys,
     help="Get only specific key(s) from the status / info output. There are "
          "two special keys available: 'all' will list all available keys in "
          "the table, 'overall.healthy' with result in  UP in case all "
@@ -192,3 +193,4 @@ admin.add_command(metrics)
 admin.add_command(workspace)
 admin.add_command(store)
 admin.add_command(user)
+admin.add_command(client)

cmem_cmemc-23.3.0/cmem/cmemc/cli/commands/client.py

@@ -0,0 +1,173 @@
+"""Keycloak client management commands"""
+
+import click
+
+from cmem.cmemc.cli import completion
+from cmem.cmemc.cli.commands import CmemcCommand, CmemcGroup
+from cmem.cmemc.cli.context import ApplicationContext
+from cmem.cmempy.config import get_keycloak_base_uri, get_keycloak_realm_id
+from cmem.cmempy.keycloak.client import (
+    get_client_by_client_id,
+    generate_client_secret,
+    get_client_secret, list_open_id_clients
+)
+
+NO_CLIENT_ERROR = "{} is not a valid client account. " \
+                "Use the 'admin client list' command " \
+                "to get a list of existing client accounts."
+
+
+@click.command(cls=CmemcCommand, name="list")
+@click.option(
+    "--raw",
+    is_flag=True,
+    help="Outputs raw JSON."
+)
+@click.option(
+    "--id-only",
+    is_flag=True,
+    help="Lists only Client ID. "
+         "This is useful for piping the IDs into other commands."
+)
+@click.pass_obj
+def list_command(app: ApplicationContext, raw, id_only):
+    """
+    List client accounts.
+
+    Outputs a list of client accounts, which can be used to get an overview as well
+    as a reference for the other commands of the `admin client` command group.
+
+    Note: The list command only outputs clients which have a client secret.
+    Use the `--raw` option to get a JSON description of all clients.
+    """
+    clients = list_open_id_clients()
+    if raw:
+        app.echo_info_json(clients)
+        return
+    if id_only:
+        for cnt in clients:
+            app.echo_info(cnt["clientId"])
+        return
+    table = []
+    for cnt in clients:
+        table.append((
+            cnt["clientId"],
+            cnt.get("description", "-")
+        ))
+    app.echo_info_table(
+        table,
+        headers=["Client ID", "Description"],
+        sort_column=0
+    )
+
+
+@click.command(cls=CmemcCommand, name="secret")
+@click.argument(
+    "client-id",
+    shell_complete=completion.client_ids
+)
+@click.option(
+    "--generate",
+    is_flag=True,
+    help="Generate a new secret"
+)
+@click.option(
+    "--output",
+    is_flag=True,
+    help="Display client secret"
+)
+@click.pass_obj
+def secret_command(app: ApplicationContext, client_id, generate, output):
+    """
+    Get or generate a new secret for a client account.
+
+    This command retrieves or generates a new secret for a client account from a realm.
+    """
+    if not output and not generate:
+        app.echo_info(click.get_current_context().get_help())
+        raise ValueError(
+            "You need to use '--output' or '--generate' as an option."
+        )
+
+    clients = get_client_by_client_id(client_id)
+    if not clients:
+        raise ValueError(NO_CLIENT_ERROR.format(client_id))
+
+    if generate:
+        if not output:
+            app.echo_info(
+                f"Generating a new secret for {client_id} ... ",
+                nl=False
+            )
+        credential = generate_client_secret(client_id=clients[0]["id"])
+        if not output:
+            app.echo_success("done")
+    else:
+        credential = get_client_secret(client_id=clients[0]["id"])
+
+    if output:
+        app.echo_result(credential["value"])
+
+
+@click.command(cls=CmemcCommand, name="open")
+@click.argument(
+    "client-ids",
+    nargs=-1,
+    required=False,
+    type=click.STRING,
+    shell_complete=completion.client_ids
+)
+@click.pass_obj
+def open_command(app: ApplicationContext, client_ids):
+    """Open clients in the browser.
+
+    With this command, you can open a client in the keycloak web
+    interface in your browser.
+
+    The command accepts multiple client IDs which results in
+    opening multiple browser tabs.
+    """
+    open_client_base_uri = (
+        f"{get_keycloak_base_uri()}/admin/master/console/#/"
+        f"{get_keycloak_realm_id()}/clients"
+    )
+    if not client_ids:
+        app.echo_debug(f"Open users list: {open_client_base_uri}")
+        click.launch(open_client_base_uri)
+    else:
+        clients = list_open_id_clients()
+        client_id_map = {c["clientId"]: c["id"] for c in clients}
+        for _ in client_ids:
+            if _ not in client_id_map.keys():
+                raise ValueError(NO_CLIENT_ERROR.format(_))
+            client_id = client_id_map[_]
+            open_user_uri = f"{open_client_base_uri}/{client_id}/settings"
+
+            app.echo_debug(f"Open {_}: {open_user_uri}")
+            click.launch(open_user_uri)
+
+
+@click.group(cls=CmemcGroup)
+def client():
+    """
+    List client accounts, get or generate client account secrets.
+
+    This command group is an opinionated interface to the Keycloak realm of your
+    Corporate Memory instance. In order to be able to use the commands in this group,
+    the configured cmemc connection account needs to be equipped with the
+    `manage-clients` role in the used realm.
+
+    Client accounts are identified by a client ID which is unique in the scope of
+    the used realm.
+
+    In case your Corporate Memory deployment does not use the default deployment
+    layout, the following additional config variables can be used in your
+    connection configuration: `KEYCLOAK_BASE_URI` defaults to
+    `{CMEM_BASE_URI}/auth` and locates your Keycloak deployment;
+    `KEYCLOAK_REALM_ID` defaults to `cmem` and identifies the used realm.
+    """
+
+
+client.add_command(list_command)
+client.add_command(secret_command)
+client.add_command(open_command)

{cmem_cmemc-23.1.3 → cmem_cmemc-23.3.0}/cmem/cmemc/cli/commands/config.py

@@ -41,7 +41,7 @@ def edit_command(app):
     "KEY",
     nargs=1,
     type=click.Choice(
-        KNOWN_CONFIG_KEYS.keys(),
+        list(KNOWN_CONFIG_KEYS.keys()),
         case_sensitive=False
     )
 )