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

cmem/cmemc/cli/context.py

@@ -31,9 +31,9 @@ from cmem.cmempy.health import (
 from cmem.cmemc.cli.exceptions import (InvalidConfiguration)
 from cmem.cmemc.cli.utils import is_completing
 
-DI_TARGET_VERSION = "v23.1"
+DI_TARGET_VERSION = "v23.3.0"
 
-DP_TARGET_VERSION = "v23.1"
+DP_TARGET_VERSION = "v23.3.0"
 
 KNOWN_CONFIG_KEYS = {
     'CMEM_BASE_URI': cmempy_config.get_cmem_base_uri,
@@ -63,6 +63,7 @@ class ApplicationContext():
     """Context of the command line interface."""
 
     # pylint: disable=too-many-instance-attributes
+    # pylint: disable=too-many-public-methods
 
     def __init__(self, debug=False, quiet=False):
         """Initialize main context."""
@@ -151,8 +152,24 @@ class ApplicationContext():
             urllib3.disable_warnings()
         return
 
+    def set_connection_from_params(self, params):
+        """Set connection and config by manually checking params (completion)."""
+        self.set_config_file(
+            getenv("CMEMC_CONFIG_FILE", self.config_file)
+        )
+        if params["config_file"]:
+            self.set_config_file(params["config_file"])
+
+        self.config = self.get_config()
+        # look for connection in environment and set connection
+        self.set_connection(
+            getenv("CMEMC_CONNECTION", '')
+        )
+        if params["connection"]:
+            self.set_connection(params["connection"])
+
     def set_connection_from_args(self, args):
-        """Set connection and config by manually checking args (completion)."""
+        """Set connection and config by manually checking param (completion)."""
         # look for environment and load config
         self.set_config_file(
             getenv("CMEMC_CONFIG_FILE", self.config_file)

cmem/cmemc/cli/manual_helper/multi_page.py

@@ -15,12 +15,14 @@ def get_icon_for_command_group(full_name):
         "admin metrics": "material/chart-line-variant",
         "admin store": "material/database-outline",
         "admin user": "material/account-cog",
+        "admin client": "material/account-cog",
         "admin workspace": "material/folder-multiple-outline",
         "admin workspace python": "material/language-python",
         "config": "material/cog-outline",
         "dataset": "eccenca/artefact-dataset",
         "dataset resource": "eccenca/artefact-file",
         "project": "eccenca/artefact-project",
+        "project variable": "material/variable-box",
         "query": "eccenca/application-queries",
         "graph": "eccenca/artefact-dataset-eccencadataplatform",
         "vocabulary": "eccenca/application-vocabularies",
@@ -38,12 +40,14 @@ def get_tags_for_command_group(full_name: str) -> str:
         "admin metrics": ["cmemc"],
         "admin store": ["SPARQL", "cmemc"],
         "admin user": ["Keycloak", "Security", "cmemc"],
+        "admin client": ["Keycloak", "Security", "cmemc"],
         "admin workspace": ["cmemc"],
         "admin workspace python": ["Python", "cmemc"],
         "config": ["Configuration", "cmemc"],
         "dataset": ["cmemc"],
         "dataset resource": ["cmemc"],
         "project": ["Project", "cmemc"],
+        "project variable": ["Variables", "cmemc"],
         "query": ["SPARQL", "cmemc"],
         "graph": ["KnowledgeGraph", "cmemc"],
         "vocabulary": ["Vocabulary", "cmemc"],
@@ -57,14 +61,15 @@ def get_tags_for_command_group(full_name: str) -> str:
     return markdown
 
 
-def enhance_help_text_markdown(
-        text: str, skip_first_line: bool = False
+def get_enhanced_help_text_markdown(
+        command_or_group, skip_first_line: bool = False
 ) -> str:
     """Add ammunition and code ticks where possible."""
+    text = command_or_group.help
+    first_line = command_or_group.get_short_help_str(limit=200)
     help_text_ = ""
     for line in text.splitlines():
-        if skip_first_line:
-            skip_first_line = False
+        if skip_first_line and line.strip().startswith(first_line):
             continue
         if line == "":
             help_text_ = f"{help_text_}\n\n"
@@ -234,7 +239,7 @@ def create_group_index_md(ctx, command_group, directory, full_name):
     Path(directory).mkdir(parents=True, exist_ok=True)
     file_name = f"{directory}/index.md"
 
-    help_text = enhance_help_text_markdown(command_group.help)
+    help_text = get_enhanced_help_text_markdown(command_group)
     # config help has now text but too much lists
     if command_group.name == "config":
         help_text = f"```text\n{command_group.help}\n```"
@@ -265,7 +270,7 @@ def get_markdown_for_command(ctx, command, group_name) -> str:
     command.format_help(ctx, formatter)
 
     # the help text is everything without options and usages
-    help_text = enhance_help_text_markdown(command.help, True)
+    help_text = get_enhanced_help_text_markdown(command, True)
 
     # the options text is the documentation of the options
     options_text_ = str(formatter.getvalue())

cmem/cmemc/cli/utils.py

@@ -3,14 +3,19 @@ import json
 import os
 import re
 import unicodedata
+from dataclasses import dataclass
 from typing import Dict
 
 from importlib.metadata import version
+
+import requests
+from bs4 import BeautifulSoup
 from prometheus_client import Metric
 from prometheus_client.parser import text_string_to_metric_families
 
 from cmem.cmempy.dp.admin import get_prometheus_data
 from cmem.cmempy.dp.proxy.graph import get_graphs_list
+from cmem.cmempy.workspace.projects.project import get_projects
 
 NAMESPACES = {
     "void": "http://rdfs.org/ns/void#",
@@ -259,3 +264,78 @@ def metrics_get_family(job_id, metric_id):
         raise ValueError(
             f"The job {job_id} does not have a metric {metric_id}."
         ) from error
+
+
+def check_or_select_project(app, project_id=None):
+    """Check for given project, select the first one if there is only one.
+
+    Args:
+        app (ApplicationContext): the click cli app context.
+        project_id (str): The project ID.
+
+    Raises:
+        ValueError: if no projects available.
+        ValueError: if more than one project is.
+
+    Returns:
+        Maybe project_id if there was no project_id before.
+    """
+    if project_id is not None:
+        return project_id
+
+    projects = get_projects()
+    if len(projects) == 1:
+        project_name = projects[0]["name"]
+        app.echo_warning(
+            "Missing project (--project) - since there is only one project, "
+            f"this is selected: {project_name}"
+        )
+        return project_name
+
+    if len(projects) == 0:
+        raise ValueError(
+            "There are no projects available. "
+            "Please create a project with 'cmemc project create'."
+        )
+
+    # more than one project
+    raise ValueError(
+        "There is more than one project available so you need to "
+        "specify the project with '--project'."
+    )
+
+
+@dataclass
+class PublishedPackage:
+    """Represents a published package from pypi.org."""
+    name: str
+    description: str
+    version: str
+    published: str
+
+
+def get_published_packages() -> list[PublishedPackage]:
+    """Get a scraped list of plugin packages scraped from pypi.org."""
+    url = "https://pypi.org/search/?q=%22cmem-plugin-%22"
+    soup = BeautifulSoup(
+        requests.get(url, timeout=5).content,
+        "html.parser"
+    )
+    packages = []
+    snippets = soup.find_all("a", class_="package-snippet")
+    for _ in snippets:
+        name = _.findChildren(class_="package-snippet__name")[0].getText()
+        if name == "cmem-plugin-base":
+            continue
+        description = _.findChildren(class_="package-snippet__description")[0].getText()
+        package_version = _.findChildren(class_="package-snippet__version")[0].getText()
+        published = _.findChildren(name="time")[0].attrs["datetime"]
+        packages.append(
+            PublishedPackage(
+                name=name,
+                description=description,
+                version=package_version,
+                published=published
+            )
+        )
+    return packages

{cmem_cmemc-23.1.3.dist-info → cmem_cmemc-23.3.0.dist-info}/METADATA

@@ -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.3.0.dist-info/RECORD

@@ -0,0 +1,35 @@
+cmem/__init__.py,sha256=OzrBXrHY3fXthcUqenPHDz_MXGlOSeyxEqasW2ZXkQ8,109
+cmem/cmemc/__init__.py,sha256=W3KviSav-BgWl_0-OvpaTQJN51yP7J8qc5QHdj0KJbI,28
+cmem/cmemc/cli/__init__.py,sha256=47s7BytGUhsTH7jF_Q28t3jIOSjVhC288SJAZBCAiuY,5838
+cmem/cmemc/cli/_cmemc.zsh,sha256=fmkrBHIQxus8cp2AgO1tzZ5mNZdGL_83cYz3a9uAdsg,1326
+cmem/cmemc/cli/commands/__init__.py,sha256=tUt6gII59eOn9mWcP0WajOpa-MxwhMXFYHNiC4Cb35U,3471
+cmem/cmemc/cli/commands/admin.py,sha256=5aXvkNrgDf1rMd7X1jOKIxFvhoWnRockfcnSLlgvQbg,6785
+cmem/cmemc/cli/commands/client.py,sha256=d7J9LoJC0hC3n5ZTuHaoNH20F2bUu-KaBNExpBZwMbo,5300
+cmem/cmemc/cli/commands/config.py,sha256=QkvEtlveUWXVHJ3TcTWL9odxhHB7BxVnom_Q-OzcBuI,5568
+cmem/cmemc/cli/commands/dataset.py,sha256=9GnR1lbjB_ov_IpQavIUU2bTlwGTPAPW7e0cJasnu1k,30602
+cmem/cmemc/cli/commands/graph.py,sha256=Ieg_DMMDoQCrLr0i6lPDqnr3_0Q7WCvYsE-wucfy1Pg,27110
+cmem/cmemc/cli/commands/metrics.py,sha256=0B8ZbydQ3EYeNfrhj8-c5AB_hD5v1KIQSTRG9OevARU,7808
+cmem/cmemc/cli/commands/project.py,sha256=zrQ9Ex1819yNJiIoztku9U9BsrWDq981MlUskAhCARQ,20221
+cmem/cmemc/cli/commands/python.py,sha256=-MKO0BosigTLJI3MiE7t1agd4WOfFx44NVM7FKDoqCE,9641
+cmem/cmemc/cli/commands/query.py,sha256=rOrM3BmK1rl67U7x-pygbs1imILsjLUvO8vIaYo0vNo,27725
+cmem/cmemc/cli/commands/resource.py,sha256=r0_Be0kDFNybAx6aQfWDuYaVa9n2lBbkhmn03Yd5KJg,7556
+cmem/cmemc/cli/commands/scheduler.py,sha256=iZ69qpxeW996kNubo17ReRF24DJARVqFC0a9ea7hY3E,8192
+cmem/cmemc/cli/commands/store.py,sha256=xT9Yh3NjiwEDNxupoZXaVmTBXecw_up7BuO4qr3TPbA,6823
+cmem/cmemc/cli/commands/user.py,sha256=2h7VgOh357TsmgYh5oNhYHFxsLN4aoZqgjW99DTThFQ,11144
+cmem/cmemc/cli/commands/variable.py,sha256=kdvKxmfOzoFl4ZuQRBQo3q5XqbBsnITZUaaYcADn4kk,11586
+cmem/cmemc/cli/commands/vocabulary.py,sha256=qFTq2YJ0zmGePyU8J0sUnGeE2_v3UYTYFyFDogpVLko,16218
+cmem/cmemc/cli/commands/workflow.py,sha256=uYaOxEKZ5ntHGmeYS46Jwq2cFw-Bvknl5UCI_lkZHTo,24354
+cmem/cmemc/cli/commands/workspace.py,sha256=TLJguKIIrruw5xNIpkDJ0BZKcSmGegtYFn7W_hTc0-Y,4761
+cmem/cmemc/cli/completion.py,sha256=aaNn3_ECqOMmVYACEYsndUvvFEfmqYJzvWKFlpMFxmI,46262
+cmem/cmemc/cli/context.py,sha256=cnEvXQ7Aq-u7UfWZaOKRd0ver17MUyihSEDZ6j1tdX4,16294
+cmem/cmemc/cli/exceptions.py,sha256=yHyHF-oZ81XIIb_trbFnWcqbzq_zPT4JaoDhFi_Stl0,139
+cmem/cmemc/cli/manual_helper/__init__.py,sha256=G3Lqw2aPxo8x63Tg7L0aa5VD9BMaRzZDmhrog7IuEPg,43
+cmem/cmemc/cli/manual_helper/graph.py,sha256=06fOyZeCXRNiQ3LyNaU2p70Z0Neax4KAJitUFVUsD30,3261
+cmem/cmemc/cli/manual_helper/multi_page.py,sha256=o3z81XqjSLX3r0F-snp3SOlV3xyQ5yAg0hnzV8U9s4Y,11452
+cmem/cmemc/cli/manual_helper/single_page.py,sha256=MNaQAwdvcHhOv5xvjDnuSRDkuimOXtIWdUa8skwYq0w,1303
+cmem/cmemc/cli/utils.py,sha256=MOrfwIa4zS1yDw2k5abIVTsO0os5Kj8uaFhtz4wWm2c,10540
+cmem_cmemc-23.3.0.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+cmem_cmemc-23.3.0.dist-info/METADATA,sha256=YeXU8JJ2_zIRoWwLhXSFYIDwYS59zEBu2lzNq13YXbw,2584
+cmem_cmemc-23.3.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+cmem_cmemc-23.3.0.dist-info/entry_points.txt,sha256=cl-mawezSjt0JzpCWfAudsm_9ekKcFGzJxlnglRno38,45
+cmem_cmemc-23.3.0.dist-info/RECORD,,

{cmem_cmemc-23.1.3.dist-info → cmem_cmemc-23.3.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.5.2
+Generator: poetry-core 1.8.1
 Root-Is-Purelib: true
 Tag: py3-none-any

cmem_cmemc-23.1.3.dist-info/RECORD

@@ -1,32 +0,0 @@
-cmem/__init__.py,sha256=OzrBXrHY3fXthcUqenPHDz_MXGlOSeyxEqasW2ZXkQ8,109
-cmem/cmemc/__init__.py,sha256=W3KviSav-BgWl_0-OvpaTQJN51yP7J8qc5QHdj0KJbI,28
-cmem/cmemc/cli/__init__.py,sha256=nOkwCdEs_wBccdfVkZKeiCbJxU4NoMzYZe84xiyvmAM,5571
-cmem/cmemc/cli/commands/__init__.py,sha256=D94DjpFGVA1eePwInGHlSFRaQJLjUB5cE6Krn8eDh74,3311
-cmem/cmemc/cli/commands/admin.py,sha256=TAECccpn0wFChY1CAdTyuM-MI3_zEhjc7iGpp_hzOVk,6709
-cmem/cmemc/cli/commands/config.py,sha256=t_TpgRzfb-cyKVPAm4UAU_ib5yhJTckatlcuB6Mils8,5562
-cmem/cmemc/cli/commands/dataset.py,sha256=Sk3xlMACvcfLuiuu79uGoX5gFp0zqoHLAGU67u2b7aI,27505
-cmem/cmemc/cli/commands/graph.py,sha256=ZcHUhBc9bH6Z4ZGfTxA7c9oQ38Sv6MeqAT-freSwxxs,27110
-cmem/cmemc/cli/commands/metrics.py,sha256=QEpezyerLaORM_gNqKMS8Nbx10dx2pJipuJdR0Hgrdk,7808
-cmem/cmemc/cli/commands/project.py,sha256=UU32GO2FX0MLD_LE0d811vDzhuH1500D1-KFC5S59PQ,17612
-cmem/cmemc/cli/commands/python.py,sha256=hKRczEg3VjRjp8HLpzXLtPD38r2EzCkPm12RmyBIVNg,6948
-cmem/cmemc/cli/commands/query.py,sha256=zTEhgvHEMfqNrDOBQ3M3swGFPo2ErV2-Zg060LKTxgc,27725
-cmem/cmemc/cli/commands/resource.py,sha256=DSpvcqWRSkfKbtV2HlVydThU3o7Q-EspE6smILe0B_o,7556
-cmem/cmemc/cli/commands/scheduler.py,sha256=wmsln-CYGqiurSyEQSLochwNShDnPvkcIjj-mDeEKy0,8192
-cmem/cmemc/cli/commands/store.py,sha256=vTWgDMjCsqrridkch7XYUgSbS2GhxQ2iB-m_To4gIx8,6961
-cmem/cmemc/cli/commands/user.py,sha256=hjye5MRrPCxn50IKmSylQK7mQiqKUEoMEWVqWtqMuNI,10654
-cmem/cmemc/cli/commands/vocabulary.py,sha256=haYTFMb3YMbvC1EqO1EuhRCPZaDBBZz-2E340zEg3fE,16218
-cmem/cmemc/cli/commands/workflow.py,sha256=Tyd3rkeqlXuJ8FplerU_WVcJrm7Hz0bu8d2QPoQ5k0Y,21832
-cmem/cmemc/cli/commands/workspace.py,sha256=7szXu6FbwcvtC4YpTaVmcPLGFHXOsoGKaco-fbQ7sUA,4761
-cmem/cmemc/cli/completion.py,sha256=PfMAkIRlXLoz-gxPkXkc4FYJQjqwPz-P8Ly3pVPvHqQ,38221
-cmem/cmemc/cli/context.py,sha256=vNQOacNobygnQB5DZr9DxJkbsZm895Uq2PZafw18wtI,15648
-cmem/cmemc/cli/exceptions.py,sha256=yHyHF-oZ81XIIb_trbFnWcqbzq_zPT4JaoDhFi_Stl0,139
-cmem/cmemc/cli/manual_helper/__init__.py,sha256=G3Lqw2aPxo8x63Tg7L0aa5VD9BMaRzZDmhrog7IuEPg,43
-cmem/cmemc/cli/manual_helper/graph.py,sha256=06fOyZeCXRNiQ3LyNaU2p70Z0Neax4KAJitUFVUsD30,3261
-cmem/cmemc/cli/manual_helper/multi_page.py,sha256=wPR-43eEFKHevVUp0v9B3bGL_PkcNsAatBr9eZU58Pk,11127
-cmem/cmemc/cli/manual_helper/single_page.py,sha256=MNaQAwdvcHhOv5xvjDnuSRDkuimOXtIWdUa8skwYq0w,1303
-cmem/cmemc/cli/utils.py,sha256=Jqb1DF8Y_DC6Hf7L2IVrinnm9ShHkLPTYjnZcPsSHFI,8086
-cmem_cmemc-23.1.3.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-cmem_cmemc-23.1.3.dist-info/METADATA,sha256=Mfo9L7FRuPAb6YAG_1w5AGhWBtHffzW_ffrfDtyPI_I,2544
-cmem_cmemc-23.1.3.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-cmem_cmemc-23.1.3.dist-info/entry_points.txt,sha256=cl-mawezSjt0JzpCWfAudsm_9ekKcFGzJxlnglRno38,45
-cmem_cmemc-23.1.3.dist-info/RECORD,,