cmem-cmemc 23.2__py3-none-any.whl → 23.3.0__py3-none-any.whl

cmem/cmemc/cli/commands/project.py

@@ -5,6 +5,7 @@ import tempfile
 from pathlib import Path
 from zipfile import ZipFile
 import click
+from click import UsageError
 from jinja2 import Template
 
 from cmem.cmemc.cli import completion
@@ -24,10 +25,11 @@ from cmem.cmempy.workspace.projects.project import (
     delete_project,
     get_failed_tasks_report,
     get_projects,
-    make_new_project,
     reload_project,
-    create_project_with_transformation
+    create_project_with_transformation,
+    make_new_project_with_metadata
 )
+from cmem.cmemc.cli.commands.variable import variable
 
 
 def _show_type_list(app):
@@ -62,7 +64,7 @@ def _show_type_list(app):
     nargs=-1,
     required=True,
     type=click.STRING,
-    autocompletion=completion.project_ids
+    shell_complete=completion.project_ids
 )
 @click.pass_obj
 def open_command(app, project_ids):
@@ -136,7 +138,7 @@ def list_command(app, raw, id_only):
     "project_ids",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.project_ids
+    shell_complete=completion.project_ids
 )
 @click.pass_obj
 def delete_command(app, all_, project_ids):
@@ -183,7 +185,7 @@ def delete_command(app, all_, project_ids):
 @click.option(
     "--from-transformation",
     nargs=1,
-    autocompletion=completion.transformation_task_ids,
+    shell_complete=completion.transformation_task_ids,
     required=False,
     help=(
             "This option can be used to explicitly create the link specification, "
@@ -191,8 +193,20 @@ def delete_command(app, all_, project_ids):
             "a transformation task. You need the task ID of the transformation task."
     ),
 )
+@click.option(
+    "--label", "labels",
+    multiple=True,
+    help="Give the label of the project. You can give more than one label if you"
+         " create more than one project."
+)
+@click.option(
+    "--description", "descriptions",
+    multiple=True,
+    help="Give the description of the project. You can give more than one description"
+         " if you create more than one project."
+)
 @click.pass_obj
-def create_command(app, project_ids, from_transformation):
+def create_command(app, project_ids, from_transformation, labels, descriptions):
     """Create projects.
 
     This command creates one or more new projects.
@@ -232,13 +246,34 @@ def create_command(app, project_ids, from_transformation):
 
     count = len(project_ids)
     current = 1
+    if len(labels) > 0 and len(labels) != count:
+        raise UsageError(
+            "Either give labels for all projects or for no project."
+            f" Got {len(labels)} labels but {count} projects."
+        )
+    if len(descriptions) > 0 and len(descriptions) != count:
+        raise UsageError(
+            "Either give descriptions for all projects or for no project."
+            f" Got {len(descriptions)} descriptions but {count} projects."
+        )
+
     for project_id in project_ids:
+        try:
+            label = labels[current - 1]
+        except IndexError:
+            label = project_id
+        try:
+            description = descriptions[current - 1]
+        except IndexError:
+            description = ""
         app.echo_info(
             f"Create new project {current}/{count}: {project_id} ... ",
             nl=False
         )
         app.echo_debug(get_projects())
-        make_new_project(project_id)
+        make_new_project_with_metadata(
+            project_id, label=label, description=description
+        )
         app.echo_success("done")
         current = current + 1
 
@@ -264,7 +299,7 @@ def create_command(app, project_ids, from_transformation):
         writable=True,
         file_okay=False
     ),
-    # autocompletion=directories,
+    # shell_complete=directories,
     help="The base directory, where the project files will be created. "
          "If this directory does not exist, it will be silently created."
 )
@@ -273,7 +308,7 @@ def create_command(app, project_ids, from_transformation):
     default="xmlZip",
     show_default=True,
     type=click.STRING,
-    autocompletion=completion.marshalling_plugins,
+    shell_complete=completion.marshalling_plugins,
     help="Type of the exported project file(s). Use the --help-types option "
          "or tab completion to see a list of possible types."
 )
@@ -282,7 +317,7 @@ def create_command(app, project_ids, from_transformation):
     default="{{date}}-{{connection}}-{{id}}.project",
     show_default=True,
     type=click.STRING,
-    autocompletion=completion.project_export_templates,
+    shell_complete=completion.project_export_templates,
     help="Template for the export file name(s). "
          "Possible placeholders are (Jinja2): "
          "{{id}} (the project ID), "
@@ -309,7 +344,7 @@ def create_command(app, project_ids, from_transformation):
     "project_ids",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.project_ids
+    shell_complete=completion.project_ids
 )
 @click.pass_obj
 def export_command(
@@ -408,7 +443,7 @@ def export_command(
 @click.command(cls=CmemcCommand, name="import")
 @click.argument(
     "path",
-    autocompletion=completion.project_files,
+    shell_complete=completion.project_files,
     type=click.Path(
         allow_dash=False,
         dir_okay=True,
@@ -421,7 +456,7 @@ def export_command(
     type=click.STRING,
     required=False,
     default='',
-    autocompletion=completion.project_ids
+    shell_complete=completion.project_ids
 )
 @click.option(
     "-o", "--overwrite",
@@ -518,7 +553,7 @@ def import_command(app, path, project_id, overwrite):
     "project_ids",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.project_ids
+    shell_complete=completion.project_ids
 )
 @click.pass_obj
 def reload_command(app, all_, project_ids):
@@ -583,3 +618,4 @@ project.add_command(import_command)
 project.add_command(delete_command)
 project.add_command(create_command)
 project.add_command(reload_command)
+project.add_command(variable)

cmem/cmemc/cli/commands/python.py

@@ -1,8 +1,10 @@
 """DataIntegration python management commands."""
 import sys
+from dataclasses import asdict
 from re import match
 
 import click
+from click import UsageError
 
 from cmem.cmemc.cli import completion
 from cmem.cmemc.cli.commands import CmemcCommand, CmemcGroup
@@ -12,6 +14,7 @@ from cmem.cmempy.workspace.python import (
     list_packages, list_plugins,
     uninstall_package, update_plugins
 )
+from cmem.cmemc.cli.utils import get_published_packages
 
 
 def _get_package_id(module_name: str) -> str:
@@ -29,7 +32,7 @@ def _looks_like_a_package(package: str) -> bool:
 @click.command(cls=CmemcCommand, name="install")
 @click.argument(
     "PACKAGE",
-    autocompletion=completion.installable_packages,
+    shell_complete=completion.installable_packages,
     type=click.Path(
         readable=True,
         allow_dash=False,
@@ -79,34 +82,58 @@ def install_command(app: ApplicationContext, package):
 @click.command(cls=CmemcCommand, name="uninstall")
 @click.argument(
     "PACKAGE_NAME",
-    autocompletion=completion.installed_package_names
+    nargs=-1,
+    shell_complete=completion.installed_package_names
+)
+@click.option(
+    "-a", "--all", "all_",
+    is_flag=True,
+    help="This option removes all installed packages from the system,"
+         " leaving only the pre-installed mandatory packages in the environment."
 )
 @click.pass_obj
-def uninstall_command(app: ApplicationContext, package_name):
-    """Uninstall a python package from the workspace.
+def uninstall_command(app: ApplicationContext, package_name, all_):
+    """Uninstall a python packages from the workspace.
 
     This command is essentially a `pip uninstall` in the remote
     python environment.
     """
-    app.echo_info(
-        f"Uninstall package {package_name} ... ",
-        nl=False
-    )
+    if all_:
+        app.echo_info(
+            "Wiping Python environment ... ",
+            nl=False
+        )
+        response = uninstall_package(package_name="--all")
+        app.echo_success("done")
+        app.echo_debug("Updated Plugins: " + str(update_plugins()))
+        return
+
+    if not package_name:
+        raise UsageError(
+            "Either give at least one package name or wipe the whole python"
+            " environment with the '--all' option."
+        )
     packages = list_packages()
     app.echo_debug(packages)
-    if package_name not in [package["name"] for package in packages]:
-        app.echo_error("not installed")
-        sys.exit(1)
-    response = uninstall_package(package_name=package_name)
-    for output_line in response["standardOutput"].splitlines():
-        app.echo_debug(output_line)
-    if response["success"]:
-        app.echo_success("done")
-        if len(response["errorOutput"].strip()) > 0:
-            app.echo_warning(response["errorOutput"])
-    else:
-        app.echo_error("error")
-        app.echo_debug(response.content.decode())
+    for _ in package_name:
+        app.echo_info(
+            f"Uninstall package {_} ... ",
+            nl=False
+        )
+        if _ not in [package["name"] for package in packages]:
+            app.echo_error("not installed")
+            app.echo_debug("Updated Plugins: " + str(update_plugins()))
+            sys.exit(1)
+        response = uninstall_package(package_name=_)
+        for output_line in response["standardOutput"].splitlines():
+            app.echo_debug(output_line)
+        if response["success"]:
+            app.echo_success("done")
+            if len(response["errorOutput"].strip()) > 0:
+                app.echo_warning(response["errorOutput"])
+        else:
+            app.echo_error("error")
+            app.echo_debug(response.content.decode())
     app.echo_debug("Updated Plugins: " + str(update_plugins()))
 
 
@@ -122,30 +149,65 @@ def uninstall_command(app: ApplicationContext, package_name):
     help="Lists only package identifier. "
          "This is useful for piping the IDs into other commands."
 )
+@click.option(
+    "--available",
+    is_flag=True,
+    help="Instead of listing installed packages, this option lists installable packages"
+         " from pypi.org, which are prefixed with 'cmem-plugin-' and so are most likely"
+         " Corporate Memory plugin packages."
+)
 @click.pass_obj
-def list_command(app: ApplicationContext, raw, id_only):
+def list_command(app: ApplicationContext, raw, id_only, available):
     """List installed python packages.
 
     This command is essentially a `pip list` in the remote python environment.
 
     It outputs a table of python package identifiers with version information.
     """
-    packages = list_packages()
+    if available:
+        published_packages = get_published_packages()
+
+        if raw:
+            app.echo_info_json(
+                [asdict(_) for _ in published_packages]
+            )
+            return
+
+        if id_only:
+            for _ in published_packages:
+                app.echo_info(_.name)
+            return
+
+        table_published = []
+        for _ in published_packages:
+            table_published.append(
+                (_.name, _.version, str(_.published)[:10], _.description)
+            )
+        app.echo_info_table(
+            table_published,
+            headers=["Name", "Version", "Published", "Description"],
+            sort_column=0
+        )
+        return
+
+    installed_packages = list_packages()
     if raw:
-        app.echo_info_json(packages)
+        app.echo_info_json(installed_packages)
         return
+
     if id_only:
-        for package in packages:
+        for package in installed_packages:
             app.echo_info(package["name"])
         return
-    table = []
-    for package in packages:
-        table.append((
+
+    table_installed = []
+    for package in installed_packages:
+        table_installed.append((
             package["name"],
             package["version"]
         ))
     app.echo_info_table(
-        table,
+        table_installed,
         headers=["Name", "Version"],
         sort_column=0
     )
@@ -215,6 +277,24 @@ def list_plugins_command(
         app.echo_error(raw_output["error"])
 
 
+@click.command(cls=CmemcCommand, name="open")
+@click.argument(
+    "PACKAGE",
+    shell_complete=completion.published_package_names,
+)
+@click.pass_obj
+def open_command(app: ApplicationContext, package):
+    """Open a package pypi.org page in the browser.
+
+    With this command, you can open the pypi.org page of a published package in your
+    browser. From there, you can follow links, review the version history as well
+    as the origin of the package, and read the provided documentation.
+    """
+    full_url = f"https://pypi.org/project/{package}/"
+    app.echo_debug(f"Open {package}: {full_url}")
+    click.launch(full_url)
+
+
 @click.group(cls=CmemcGroup)
 def python():
     """List, install, or uninstall python packages.
@@ -232,3 +312,4 @@ python.add_command(install_command)
 python.add_command(uninstall_command)
 python.add_command(list_command)
 python.add_command(list_plugins_command)
+python.add_command(open_command)

cmem/cmemc/cli/commands/query.py

@@ -452,7 +452,7 @@ def list_command(app, id_only):
     "QUERIES",
     nargs=-1,
     required=True,
-    autocompletion=completion.remote_queries_and_sparql_files
+    shell_complete=completion.remote_queries_and_sparql_files
 )
 @click.option(
     "--accept",
@@ -482,7 +482,7 @@ def list_command(app, id_only):
 @click.option(
     "--parameter", "-p",
     type=(str, str),
-    autocompletion=completion.placeholder,
+    shell_complete=completion.placeholder,
     multiple=True,
     help="In case of a parameterized query (placeholders with the '{{key}}' "
          "syntax), this option fills all placeholder with a given value "
@@ -582,7 +582,7 @@ def execute_command(
     "QUERIES",
     nargs=-1,
     required=True,
-    autocompletion=completion.remote_queries_and_sparql_files
+    shell_complete=completion.remote_queries_and_sparql_files
 )
 @click.pass_obj
 def open_command(app, queries):
@@ -623,7 +623,7 @@ def open_command(app, queries):
     "--filter", "filter_",
     type=(str, str),
     multiple=True,
-    autocompletion=completion.query_status_filter,
+    shell_complete=completion.query_status_filter,
     help=QUERY_FILTER_HELP_TEXT,
 )
 @click.argument(
@@ -685,7 +685,7 @@ def status_command(app, id_only, raw, filter_, query_uuid):
 @click.argument(
     "REPLAY_FILE",
     required=True,
-    autocompletion=completion.replay_files,
+    shell_complete=completion.replay_files,
     type=click.Path(
         exists=True,
         allow_dash=False,
@@ -717,7 +717,7 @@ def status_command(app, id_only, raw, filter_, query_uuid):
 @click.option(
     "--output-file",
     required=False,
-    autocompletion=completion.replay_files,
+    shell_complete=completion.replay_files,
     help="Save the optional output to this file. Input and output of the "
          "command can be the same file. The output is written at the end "
          "of a successful command execution. The output can be stdout "

cmem/cmemc/cli/commands/resource.py

@@ -61,7 +61,7 @@ def _get_resources_filtered(resources, filter_name, filter_value):
     "--filter", "filters_",
     multiple=True,
     type=(str, str),
-    autocompletion=completion.resource_list_filter,
+    shell_complete=completion.resource_list_filter,
     help=RESOURCE_FILTER_TEXT
 )
 @click.pass_obj
@@ -101,7 +101,7 @@ def list_command(app, raw, id_only, filters_):
     "resource_ids",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.resource_ids
+    shell_complete=completion.resource_ids
 )
 @click.option(
     "--force",
@@ -118,7 +118,7 @@ def list_command(app, raw, id_only, filters_):
     "--filter", "filters_",
     multiple=True,
     type=(str, str),
-    autocompletion=completion.resource_list_filter,
+    shell_complete=completion.resource_list_filter,
     help=RESOURCE_FILTER_TEXT
 )
 @click.pass_obj
@@ -184,7 +184,7 @@ def delete_command(app, resource_ids, force, all_, filters_):
 @click.argument(
     "resource_id",
     type=click.STRING,
-    autocompletion=completion.resource_ids
+    shell_complete=completion.resource_ids
 )
 @click.option(
     "--raw",
@@ -211,7 +211,7 @@ def inspect_command(app, resource_id, raw):
 @click.argument(
     "resource_id",
     type=click.STRING,
-    autocompletion=completion.resource_ids
+    shell_complete=completion.resource_ids
 )
 @click.option(
     "--raw",

cmem/cmemc/cli/commands/scheduler.py

@@ -38,7 +38,7 @@ def _get_sorted_scheduler_ids():
     nargs=-1,
     required=True,
     type=click.STRING,
-    autocompletion=completion.scheduler_ids
+    shell_complete=completion.scheduler_ids
 )
 @click.option(
     "--workflow",
@@ -121,7 +121,7 @@ def list_command(app, raw, id_only):
 @click.argument(
     "scheduler_id",
     type=click.STRING,
-    autocompletion=completion.scheduler_ids
+    shell_complete=completion.scheduler_ids
 )
 @click.option(
     "--raw",
@@ -150,7 +150,7 @@ def inspect_command(app, scheduler_id, raw):
     "scheduler_ids",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.scheduler_ids
+    shell_complete=completion.scheduler_ids
 )
 @click.option(
     "-a", "--all", "all_",
@@ -198,7 +198,7 @@ def disable_command(app, scheduler_ids, all_):
     "scheduler_ids",
     nargs=-1,
     type=click.STRING,
-    autocompletion=completion.scheduler_ids
+    shell_complete=completion.scheduler_ids
 )
 @click.option(
     "-a", "--all", "all_",

cmem/cmemc/cli/commands/store.py

@@ -1,14 +1,18 @@
 """DataPlatform store commands for the cmem command line interface."""
 import os
-import sys
 from os.path import exists
 
 import click
+from click import UsageError
 
 from cmem.cmemc.cli import completion
 from cmem.cmemc.cli.commands import CmemcCommand, CmemcGroup
 from cmem.cmemc.cli.context import ApplicationContext
-from cmem.cmempy.dp.admin import create_showcase_data, import_bootstrap_data
+from cmem.cmempy.dp.admin import (
+    create_showcase_data,
+    delete_bootstrap_data,
+    import_bootstrap_data
+)
 from cmem.cmempy.dp.admin.backup import get_zip, post_zip
 
 
@@ -17,32 +21,37 @@ from cmem.cmempy.dp.admin.backup import get_zip, post_zip
     "--import", "import_",
     is_flag=True,
     help="Delete existing bootstrap data if present and import bootstrap "
-         "data which was delivered "
+         "data which was delivered with Corporate Memory."
+)
+@click.option(
+    "--remove",
+    is_flag=True,
+    help="Delete existing bootstrap data if present."
 )
 @click.pass_obj
-def bootstrap_command(app: ApplicationContext, import_):
-    """Update/Import bootstrap data.
+def bootstrap_command(app: ApplicationContext, import_, remove):
+    """Update/Import or remove bootstrap data.
+
+    Use `--import` to import the bootstrap data needed for managing shapes and
+    configuration objects. This will remove the old data first.
 
-    This command imports the bootstrap data needed for managing shapes and
-    configuration objects.
+    Use `--remove` to delete bootstrap data.
 
-    Note: The command will first remove all existing bootstrap data
-    (identified with the isSystemResource flag) and will then import the new data
-    to the corresponding graphs (shape catalog, vocabulary catalog, configuration
-    graph).
+    Note: The removal of existing bootstrap data will search for resources which are
+    flagged with the isSystemResource property.
     """
-    if "store" not in sys.argv:
-        app.echo_warning(
-            "The 'admin bootstrap' command is deprecated and will be removed "
-            "in the next major release.\n"
-            "Please use the 'admin store bootstrap' command instead."
-        )
-    if not import_:
-        raise ValueError("Use the --import flag to update/import "
-                         "bootstrap data.")
-    app.echo_info("Update or import bootstrap data ... ", nl=False)
-    import_bootstrap_data()
-    app.echo_success("done")
+    if import_ and remove or not import_ and not remove:
+        raise UsageError("Either use the --import or the --remove option.")
+    if import_:
+        app.echo_info("Update or import bootstrap data ... ", nl=False)
+        import_bootstrap_data()
+        app.echo_success("done")
+        return
+    if remove:
+        app.echo_info("Remove bootstrap data ... ", nl=False)
+        delete_bootstrap_data()
+        app.echo_success("done")
+        return
 
 
 @click.command(cls=CmemcCommand, name="showcase")
@@ -77,12 +86,6 @@ def showcase_command(app, scale, create, delete):
     you need to remove the showcase graphs manually (or just remove all
     graphs).
     """
-    if "store" not in sys.argv:
-        app.echo_warning(
-            "The 'admin showcase' command is deprecated and will be removed "
-            "in the next major release.\n"
-            "Please use the 'admin store showcase' command instead."
-        )
     if not delete and not create:
         raise ValueError("Either use the --create or the --delete flag.")
     if delete:
@@ -102,7 +105,7 @@ def showcase_command(app, scale, create, delete):
 @click.command(cls=CmemcCommand, name="export")
 @click.argument(
     "BACKUP_FILE",
-    autocompletion=completion.graph_backup_files,
+    shell_complete=completion.graph_backup_files,
     required=True,
     type=click.Path(
         writable=True,
@@ -161,7 +164,7 @@ def export_command(app, backup_file, overwrite):
 @click.command(cls=CmemcCommand, name="import")
 @click.argument(
     "BACKUP_FILE",
-    autocompletion=completion.graph_backup_files,
+    shell_complete=completion.graph_backup_files,
     required=True,
     type=click.Path(
         readable=True,

cmem/cmemc/cli/commands/user.py

@@ -76,7 +76,7 @@ def list_command(app: ApplicationContext, raw, id_only):
 @click.command(cls=CmemcCommand, name="delete")
 @click.argument(
     "username",
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.pass_obj
 def delete_command(app: ApplicationContext, username):
@@ -130,7 +130,7 @@ def create_command(app: ApplicationContext, username):
 @click.command(cls=CmemcCommand, name="update")
 @click.argument(
     "username",
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.option(
     "--first-name",
@@ -154,14 +154,14 @@ def create_command(app: ApplicationContext, username):
     "--assign-group",
     type=click.STRING,
     multiple=True,
-    autocompletion=completion.user_group_ids,
+    shell_complete=completion.user_group_ids,
     help="Assign a group."
 )
 @click.option(
     "--unassign-group",
     type=click.STRING,
     multiple=True,
-    autocompletion=completion.user_group_ids,
+    shell_complete=completion.user_group_ids,
     help="Unassign a group."
 )
 @click.pass_obj
@@ -238,7 +238,7 @@ def update_command(
 @click.command(cls=CmemcCommand, name="password")
 @click.argument(
     "username",
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.option(
     "--value",
@@ -304,7 +304,7 @@ def password_command(
     nargs=-1,
     required=False,
     type=click.STRING,
-    autocompletion=completion.user_ids
+    shell_complete=completion.user_ids
 )
 @click.pass_obj
 def open_command(app: ApplicationContext, usernames: str):