yellowdog-python-examples 8.2.1__tar.gz → 8.3.0__tar.gz

{yellowdog_python_examples-8.2.1/yellowdog_python_examples.egg-info → yellowdog_python_examples-8.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 8.2.1
+Version: 8.3.0
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 License-Expression: Apache-2.0
@@ -26,7 +26,7 @@ Requires-Dist: requests
 Requires-Dist: rich==13.9.4
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: toml
-Requires-Dist: yellowdog-sdk>=11.7.0
+Requires-Dist: yellowdog-sdk>=11.8.1
 Provides-Extra: jsonnet
 Requires-Dist: jsonnet; extra == "jsonnet"
 Provides-Extra: cloudwizard
@@ -62,6 +62,7 @@ The commands support:
 - **Provisioning** Worker Pools with the **`yd-provision`** command
 - **Resizing** Worker Pools and Compute Requirements with the **`yd-resize`** command
 - **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command
+- **Showing** the details of the current Application with the **`yd-application`** command
 - **Shutting Down** Worker Pools and Nodes with the **`yd-shutdown`** command
 - **Starting** HELD Work Requirements and **Holding** (or pausing) RUNNING Work Requirements with the **`yd-start`** and **`yd-hold`** commands
 - **Submitting** Work Requirements with the **`yd-submit`** command

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/PYPI_README.md

@@ -20,6 +20,7 @@ The commands support:
 - **Provisioning** Worker Pools with the **`yd-provision`** command
 - **Resizing** Worker Pools and Compute Requirements with the **`yd-resize`** command
 - **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command
+- **Showing** the details of the current Application with the **`yd-application`** command
 - **Shutting Down** Worker Pools and Nodes with the **`yd-shutdown`** command
 - **Starting** HELD Work Requirements and **Holding** (or pausing) RUNNING Work Requirements with the **`yd-start`** and **`yd-hold`** commands
 - **Submitting** Work Requirements with the **`yd-submit`** command

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/README.md

@@ -132,9 +132,10 @@
    * [yd-show](#yd-show)
    * [yd-compare](#yd-compare)
    * [yd-finish](#yd-finish)
+   * [yd-application](#yd-application)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Fri Oct 24 12:05:26 BST 2025 -->
+<!-- Added by: pwt, at: Mon Feb  2 12:15:54 GMT 2026 -->
 
 <!--te-->
 
@@ -165,6 +166,7 @@ The commands provide the following capabilities:
 - **Provisioning** Worker Pools with the **`yd-provision`** command
 - **Resizing** Worker Pools and Compute Requirements with the **`yd-resize`** command
 - **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command
+- **Showing** the details of the current Application with the **`yd-application`** command
 - **Shutting Down** Worker Pools and Nodes with the **`yd-shutdown`** command
 - **Starting** HELD Work Requirements and **Holding** (or pausing) RUNNING Work Requirements with the **`yd-start`** and **`yd-hold`** commands
 - **Submitting** Work Requirements with the **`yd-submit`** command
@@ -3037,3 +3039,7 @@ The match status of a Worker Pool falls into one of four categories:
 ## yd-finish
 
 The `yd-finish` command moves work requirements into the `FINISHING` state, meaning the requirements will be allowed to conclude but that no new tasks can be added.
+
+## yd-application
+
+The `yd-application` command shows the details of the current Application, i.e., the Application represented by the `key` and `secret` being used.

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/pyproject.toml

@@ -48,6 +48,7 @@
 
 [project.scripts]
     yd-abort = "yellowdog_cli.abort:main"
+    yd-application = "yellowdog_cli.application:main"
     yd-boost = "yellowdog_cli.boost:main"
     yd-cancel = "yellowdog_cli.cancel:main"
     yd-cloudwizard = "yellowdog_cli.cloudwizard:main"

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/requirements.txt

@@ -5,4 +5,4 @@ requests
 rich == 13.9.4
 tabulate >= 0.9.0
 toml
-yellowdog-sdk >= 11.7.0
+yellowdog-sdk >= 11.8.1

yellowdog_python_examples-8.3.0/yellowdog_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "8.3.0"

yellowdog_python_examples-8.3.0/yellowdog_cli/application.py

@@ -0,0 +1,104 @@
+#!/usr/bin/env python3
+
+"""
+A script for reporting on the details of the Application being used.
+"""
+
+from yellowdog_client.model import ApplicationDetails
+
+from yellowdog_cli.utils.entity_utils import (
+    get_all_roles_and_namespaces_for_application,
+    get_application_details,
+    get_application_group_summaries,
+)
+from yellowdog_cli.utils.printing import print_simple
+from yellowdog_cli.utils.wrapper import CLIENT, CONFIG_COMMON, main_wrapper
+
+
+@main_wrapper
+def main():
+
+    application_details: ApplicationDetails = get_application_details(CLIENT)
+
+    print()
+    print_simple(
+        f"  Application name:                  {application_details.name}",
+        override_quiet=True,
+    )
+    print_simple(
+        f"  Application ID:                    {application_details.id}",
+        override_quiet=True,
+    )
+    print_simple(
+        f"  Account name:                      {application_details.accountName}",
+        override_quiet=True,
+    )
+    if "api" in CONFIG_COMMON.url:
+        print_simple(
+            "  Portal URL:                        "
+            f"{CONFIG_COMMON.url.replace('api', 'portal')}"
+            f"/#/signin?account={application_details.accountName}",
+            override_quiet=True,
+        )
+    print_simple(
+        f"  Account ID:                        {application_details.accountId}",
+        override_quiet=True,
+    )
+    features = (
+        ""
+        if application_details.features is None
+        else ", ".join([str(feature) for feature in application_details.features])
+    )
+    print_simple(
+        f"  Account features:                  {features}",
+        override_quiet=True,
+    )
+    all_ns_readable = "Yes" if application_details.allNamespacesReadable else "No"
+    print_simple(
+        f"  All namespaces readable:           {all_ns_readable}",
+        override_quiet=True,
+    )
+    if not application_details.allNamespacesReadable:
+        readable_namespaces = (
+            ""
+            if application_details.readableNamespaces is None
+            else ", ".join([rns for rns in application_details.readableNamespaces])
+        )
+        print_simple(
+            f"  Readable namespaces:               {readable_namespaces}",
+            override_quiet=True,
+        )
+    try:
+        groups = get_application_group_summaries(CLIENT, application_details.id)
+        group_names = ", ".join([group.name for group in groups])
+        print_simple(
+            f"  In group(s):                       {group_names}",
+            override_quiet=True,
+        )
+        for i, (role, namespaces) in enumerate(
+            get_all_roles_and_namespaces_for_application(
+                CLIENT, application_details.id
+            ).items()
+        ):
+            msg = f"{role} [{', '.join(namespaces)}]"
+            if i == 0:
+                print_simple(
+                    f"  With role(s) [in namespace(s)]:    {msg}",
+                    override_quiet=True,
+                )
+            else:
+                print_simple(
+                    f"                                     {msg}",
+                    override_quiet=True,
+                )
+
+    except Exception as e:
+        if "Forbidden" in str(e):
+            print_simple(
+                "  Groups and roles:                  "
+                "Cannot be determined due to application permissions",
+                override_quiet=True,
+            )
+        else:
+            pass
+    print()

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/create.py

@@ -55,7 +55,7 @@ from yellowdog_cli.utils.entity_utils import (
     find_compute_requirement_template_id_by_name,
     find_compute_source_template_id_by_name,
     find_image_name_or_id,
-    get_application_groups,
+    get_application_group_summaries,
     get_application_id_by_name,
     get_group_id_by_name,
     get_group_name_by_id,
@@ -1156,7 +1156,7 @@ def create_application(resource: Dict):
         Helper function to add/remove groups from an application.
         """
         current_group_ids = {
-            group.id for group in get_application_groups(CLIENT, app.id)
+            group.id for group in get_application_group_summaries(CLIENT, app.id)
         }
 
         if current_group_ids == new_group_ids:

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/list.py

@@ -52,7 +52,7 @@ from yellowdog_cli.utils.entity_utils import (
     get_all_groups,
     get_all_roles,
     get_all_users,
-    get_application_groups,
+    get_application_group_summaries,
     get_compute_requirement_summaries,
     get_compute_requirement_templates,
     get_compute_source_templates,
@@ -992,7 +992,9 @@ def list_applications():
                 {
                     PROP_GROUPS: [
                         group.name
-                        for group in get_application_groups(CLIENT, application.id)
+                        for group in get_application_group_summaries(
+                            CLIENT, application.id
+                        )
                     ],
                     PROP_RESOURCE: RN_APPLICATION,
                 },

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/show.py

@@ -8,7 +8,7 @@ from yellowdog_client.model import ConfiguredWorkerPool
 
 from yellowdog_cli.list import get_keyring
 from yellowdog_cli.utils.entity_utils import (
-    get_application_groups,
+    get_application_group_summaries,
     substitute_id_for_name_in_allowance,
     substitute_ids_for_names_in_crt,
     substitute_image_family_id_for_name_in_cst,
@@ -225,7 +225,9 @@ def show_details(ydid: str, initial_indent: int = 0, with_final_comma: bool = Fa
 
         elif ydid_type == YDIDType.APPLICATION:
             print_log(f"Showing details of Application ID '{ydid}'")
-            group_names = [group.name for group in get_application_groups(CLIENT, ydid)]
+            group_names = [
+                group.name for group in get_application_group_summaries(CLIENT, ydid)
+            ]
             print_yd_object(
                 CLIENT.account_client.get_application(ydid),
                 initial_indent=initial_indent,

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/utils/args.py

@@ -1884,6 +1884,8 @@ def lookup_module_description(module_name: str) -> Optional[str]:
             "comparing whether a work requirement or task group is matched by "
             "workers in the specified provisioned worker pools"
         )
+    elif "application" in module_name:
+        suffix = "reporting the details of the current Application"
 
     return None if suffix is None else prefix + suffix
 

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/utils/entity_utils.py

@@ -3,7 +3,7 @@ Various utility functions for finding objects, etc.
 """
 
 from functools import lru_cache
-from typing import Callable, List, Optional, Tuple, Union
+from typing import Callable, Dict, List, Optional, Tuple, Union
 
 from yellowdog_client import PlatformClient
 from yellowdog_client.common import SearchClient
@@ -11,6 +11,7 @@ from yellowdog_client.model import (
     AccountAllowance,
     AllowanceSearch,
     Application,
+    ApplicationDetails,
     ApplicationSearch,
     ComputeRequirementStatus,
     ComputeRequirementSummary,
@@ -22,6 +23,7 @@ from yellowdog_client.model import (
     ComputeSourceTemplateSearch,
     ComputeSourceTemplateSummary,
     ExternalUser,
+    Group,
     GroupSearch,
     GroupSummary,
     ImageAccess,
@@ -385,7 +387,7 @@ def find_image_name_or_id(
     PUBLIC images.
 
     Finally, if nothing matches, the original ID is returned. This is
-    likely to be a provider specific string.
+    likely to be a provider-specific string.
     """
     if image_name_or_id is None:
         return None
@@ -522,6 +524,7 @@ def find_image_name_or_id(
                     )
 
     # Finally, fall through and return the unchanged, original ID string
+    print_log(f"No Images ID substitution possible for '{original_image_name_or_id}'")
     return original_image_name_or_id
 
 
@@ -915,21 +918,71 @@ def get_application_id_by_name(client: PlatformClient, app_name: str) -> Optiona
     return None
 
 
-def clear_application_caches():
+@lru_cache
+def get_application_details(client: PlatformClient) -> ApplicationDetails:
     """
-    Clear the application caches.
+    Load and cache the Application's details
     """
-    get_all_applications.cache_clear()
-    get_application_id_by_name.cache_clear()
+    return client.application_client.get_application_details()
 
 
-def get_application_groups(client: PlatformClient, app_id: str) -> List[GroupSummary]:
+@lru_cache
+def get_application_group_summaries(
+    client: PlatformClient, app_id: str
+) -> List[GroupSummary]:
     """
-    Get the groups to which an application belongs.
+    Get the summaries of the groups to which an application belongs.
     """
     return client.account_client.get_application_groups(app_id).list_all()
 
 
+@lru_cache
+def get_application_groups(client: PlatformClient, app_id: str) -> List[Group]:
+    """
+    Get the groups to which an application belongs.
+    """
+    return [
+        client.account_client.get_group(group_summary.id)
+        for group_summary in get_application_group_summaries(client, app_id)
+    ]
+
+
+@lru_cache
+def get_all_roles_and_namespaces_for_application(
+    client: PlatformClient, application_id: str
+) -> Dict:
+    """
+    Get a list of roles and the namespaces to which they apply, for a given application.
+    Returns {role_name: [namespace, ...]}, sorted by role name.
+    """
+    # Iterate through groups, roles
+    roles_ = dict()
+    for group in get_application_groups(client, application_id):
+        for role in group.roles:
+            if roles_.get(role.role.name) is None:
+                roles_[role.role.name] = []
+                if role.scope.global_:
+                    roles_[role.role.name] += ["GLOBAL"]
+                else:
+                    roles_[role.role.name] += [
+                        namespace.namespace for namespace in role.scope.namespaces
+                    ]
+
+    return {role: namespaces for role, namespaces in sorted(roles_.items())}
+
+
+def clear_application_caches():
+    """
+    Clear the application caches.
+    """
+    get_all_applications.cache_clear()
+    get_application_id_by_name.cache_clear()
+    get_application_details.cache_clear()
+    get_application_group_summaries.cache_clear()
+    get_application_groups.cache_clear()
+    get_all_roles_and_namespaces_for_application.cache_clear()
+
+
 def get_user_groups(client: PlatformClient, user_id: str) -> List[GroupSummary]:
     """
     Get the groups to which a user belongs.
@@ -1013,13 +1066,25 @@ def get_image_family_summaries(
     """
     Obtain and cache the list of image families.
     """
-    # Temporarily suppress most permission errors: will be improved
-    # once the application can be queried for its admissible
-    # IMAGE_READ namespaces
+    # Determine namespace(s) to search
+    if namespace is None:
+        # Attempt to use the namespace(s) that are 'readable' by
+        # this application; does not guarantee IMAGE_READ
+        application_details = get_application_details(client)
+        if application_details.allNamespacesReadable:
+            namespaces = None  # Search all namespaces
+        elif application_details.readableNamespaces is not None:
+            namespaces = application_details.readableNamespaces
+        else:
+            namespaces = []
+    else:
+        # Use the supplied namespace
+        namespaces = [namespace]
+
     try:
         if_search = MachineImageFamilySearch(
             familyName=None,
-            namespaces=None if namespace is None else [namespace],
+            namespaces=namespaces,
             includePublic=True,
         )
         search_client: SearchClient = client.images_client.get_image_families(if_search)

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/utils/misc_utils.py

@@ -256,7 +256,10 @@ def load_dotenv_file():
     if dotenv_file == "":
         return
 
-    print_log(f"Loading environment variables from '{dotenv_file}'")
+    print_log(
+        f"Loading environment variables from '{dotenv_file}' ("
+        f"{'' if ARGS_PARSER.env_override else 'NOT '}OVERRIDING existing variables)"
+    )
 
     dotenv_yd_substitutions = [  # Find 'YD' variables
         f"'{key}'"

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_cli/utils/wrapper.py

@@ -5,11 +5,10 @@ for all commands.
 
 import os
 from sys import exit
-from typing import List
 
 from pypac import pac_context_for_url
 from yellowdog_client import PlatformClient
-from yellowdog_client.model import ApiKey, KeyringSummary, ServicesSchema
+from yellowdog_client.model import ApiKey, ServicesSchema
 
 from yellowdog_cli.utils.args import ARGS_PARSER
 from yellowdog_cli.utils.config_types import ConfigCommon
@@ -22,62 +21,38 @@ CLIENT = PlatformClient.create(
     ApiKey(CONFIG_COMMON.key, CONFIG_COMMON.secret),
 )
 
-from requests.exceptions import HTTPError
-
 
 def dry_run() -> bool:
     """
     Is this a dry-run?
     """
-    dry_run = ARGS_PARSER.dry_run or ARGS_PARSER.process_csv_only
-    if dry_run is None:
+    dry_run_ = ARGS_PARSER.dry_run or ARGS_PARSER.process_csv_only
+    if dry_run_ is None:
         return False
     else:
-        return dry_run
-
-
-def print_account():
-    """
-    Print the six character hexadecimal account ID. Depends on there
-    being at least one Keyring in the account. Omit if this is a dry run.
-    """
-    if not dry_run():
-        try:
-            keyrings: List[KeyringSummary] = CLIENT.keyring_client.find_all_keyrings()
-            if len(keyrings) > 0:
-                # This is a little brittle, obviously
-                print_log(
-                    f"YellowDog Account short identifier is: '{keyrings[0].id[13:19]}'"
-                )
-        except HTTPError as e:
-            if "Unauthorized" in str(e):
-                print_error(
-                    "Unable to authorise YellowDog Application; please check"
-                    " your Application Key/Secret and its permissions"
-                )
-                exit(1)
-        except:
-            pass
+        return dry_run_
 
 
 def set_proxy():
     """
     Set the HTTPS proxy using autoconfiguration (PAC) if enabled.
     """
-    if not dry_run():
-        proxy_var = "HTTPS_PROXY"
-        if CONFIG_COMMON.use_pac:
-            print_log("Using Proxy Auto-Configuration (PAC)")
-            with pac_context_for_url(CONFIG_COMMON.url):
-                https_proxy = os.getenv(proxy_var, None)
-            if https_proxy is not None:
-                os.environ[proxy_var] = https_proxy
-            else:
-                print_log("No PAC proxy settings found")
-        else:
+    if dry_run():
+        return
+
+    proxy_var = "HTTPS_PROXY"
+    if CONFIG_COMMON.use_pac:
+        print_log("Using Proxy Auto-Configuration (PAC)")
+        with pac_context_for_url(CONFIG_COMMON.url):
             https_proxy = os.getenv(proxy_var, None)
         if https_proxy is not None:
-            print_log(f"Using {proxy_var}={https_proxy}")
+            os.environ[proxy_var] = https_proxy
+        else:
+            print_log("No PAC proxy settings found")
+    else:
+        https_proxy = os.getenv(proxy_var, None)
+    if https_proxy is not None:
+        print_log(f"Using {proxy_var}={https_proxy}")
 
 
 def main_wrapper(func):
@@ -86,7 +61,6 @@ def main_wrapper(func):
             exit_code = 0
             try:
                 set_proxy()
-                # print_account()
                 func()
             except Exception as e:
                 if "MissingPermissionException" in str(e):
@@ -96,6 +70,10 @@ def main_wrapper(func):
                         " Application belongs to the required group(s), e.g.,"
                         f" 'administrators', with roles in the required namespace(s): {e}"
                     )
+                elif "Unauthorized" in str(e):
+                    print_error(
+                        f"Your Application Key ID and SECRET are not recognised: {e}"
+                    )
                 else:
                     print_error(e)
                 exit_code = 1
@@ -109,11 +87,12 @@ def main_wrapper(func):
                     print_log("Done")
                 exit(exit_code)
         else:
-            set_proxy()
-            # print_account()
-            func()
-            CLIENT.close()
-            print_log("Done")
-            exit(0)
+            try:
+                set_proxy()
+                func()
+                print_log("Done")
+                exit(0)
+            finally:
+                CLIENT.close()
 
     return wrapper

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 8.2.1
+Version: 8.3.0
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 License-Expression: Apache-2.0
@@ -26,7 +26,7 @@ Requires-Dist: requests
 Requires-Dist: rich==13.9.4
 Requires-Dist: tabulate>=0.9.0
 Requires-Dist: toml
-Requires-Dist: yellowdog-sdk>=11.7.0
+Requires-Dist: yellowdog-sdk>=11.8.1
 Provides-Extra: jsonnet
 Requires-Dist: jsonnet; extra == "jsonnet"
 Provides-Extra: cloudwizard
@@ -62,6 +62,7 @@ The commands support:
 - **Provisioning** Worker Pools with the **`yd-provision`** command
 - **Resizing** Worker Pools and Compute Requirements with the **`yd-resize`** command
 - **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command
+- **Showing** the details of the current Application with the **`yd-application`** command
 - **Shutting Down** Worker Pools and Nodes with the **`yd-shutdown`** command
 - **Starting** HELD Work Requirements and **Holding** (or pausing) RUNNING Work Requirements with the **`yd-start`** and **`yd-hold`** commands
 - **Submitting** Work Requirements with the **`yd-submit`** command

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_python_examples.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ tests/test_variable_processing.py
 yellowdog_cli/__init__.py
 yellowdog_cli/abort.py
 yellowdog_cli/admin.py
+yellowdog_cli/application.py
 yellowdog_cli/boost.py
 yellowdog_cli/cancel.py
 yellowdog_cli/cloudwizard.py

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_python_examples.egg-info/entry_points.txt

@@ -1,5 +1,6 @@
 [console_scripts]
 yd-abort = yellowdog_cli.abort:main
+yd-application = yellowdog_cli.application:main
 yd-boost = yellowdog_cli.boost:main
 yd-cancel = yellowdog_cli.cancel:main
 yd-cloudwizard = yellowdog_cli.cloudwizard:main

{yellowdog_python_examples-8.2.1 → yellowdog_python_examples-8.3.0}/yellowdog_python_examples.egg-info/requires.txt

@@ -5,7 +5,7 @@ requests
 rich==13.9.4
 tabulate>=0.9.0
 toml
-yellowdog-sdk>=11.7.0
+yellowdog-sdk>=11.8.1
 
 [cloudwizard]
 boto3

yellowdog_python_examples-8.2.1/yellowdog_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "8.2.1"