yellowdog-python-examples 7.15.2__tar.gz → 7.15.3__tar.gz

{yellowdog_python_examples-7.15.2/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.15.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: yellowdog-python-examples
-Version: 7.15.2
+Version: 7.15.3
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3}/README.md

@@ -123,10 +123,10 @@
    * [yd-hold](#yd-hold)
    * [yd-boost](#yd-boost)
    * [yd-show](#yd-show)
-   * [yd-analyse](#yd-analyse)
+   * [yd-compare](#yd-compare)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Sun Feb 23 10:18:32 GMT 2025 -->
+<!-- Added by: pwt, at: Wed Feb 26 15:47:37 GMT 2025 -->
 
 <!--te-->
 
@@ -160,7 +160,7 @@ The commands provide the following capabilities:
 - **Creating, Updating and Removing** Source Templates, Compute Templates, Keyrings, Credentials, Namespace Storage Configurations, Image Families, Allowances, Configured Worker Pools, User Attributes, and Namespace Policies with the **`yd-create`** and **`yd-remove`** commands
 - **Following Event Streams** for Work Requirements, Worker Pools and Compute Requirements with the **`yd-follow`** command
 - **Showing** the details of any YellowDog entity using its YellowDog ID with the **`yd-show`** command
-- **Analysing** whether worker pools are match for task groups
+- **Comparing** whether worker pools are a match for task groups with the **`yd-compare`** command
 
 The operation of the commands is controlled using TOML configuration files and/or environment variables and command line arguments. In addition, Work Requirements and Worker Pools can be defined using JSON files providing extensive configurability.
 
@@ -1060,7 +1060,7 @@ To examine the JSON that will actually be sent to the YellowDog API after all pr
 
 A dry-run is useful for inspecting the results of all the processing that's been performed. To suppress all output except for the JSON itself, add the `--quiet` (`-q`) command line option.
 
-Note that the generated JSON is a consolidated form of what would be submitted to the YellowDog API, and Tasks are presented directly within their Task Groups for ease of comprehension. In actual API submissions, the Work Requirement with its Task Groups is submitted first, and Tasks are then added to their Task Groups separately, in subsequent API calls.
+Note that the generated JSON is a consolidated form of what would be submitted to the YellowDog API, and Tasks are presented directly within their Task Groups for ease of comprehension. In actual API submissions, the Work Requirement with zero or more Task Groups is submitted first, and Tasks are then added to their Task Groups separately, in subsequent API calls. Task Groups and Tasks can also later be added to the Work Requirement.
 
 A simple example of the JSON output is shown below, showing a Work Requirement with a single Task Group, containing a single Task.
 
@@ -2771,17 +2771,17 @@ The `yd-show` command will show the details (in JSON) of any YellowDog entity th
 - Keyrings
 - Allowances
 
-## yd-analyse
+## yd-compare
 
-The `yd-analyse` command takes a Work Requirement or Task Group ID and one or more Worker Pool IDs, and matches the selected Task Group(s) against the available Nodes/Workers in the Worker Pool(s). If a Work Requirement ID is supplied, all Task Groups in the Work Requirement will be analysed.
+The `yd-compare` command takes a Work Requirement or Task Group ID and one or more Worker Pool IDs, and compares the selected Task Group(s) against the available Nodes/Workers in the Worker Pool(s). If a Work Requirement ID is supplied, all Task Groups in the Work Requirement will be comapared.
 
 ```commandline
-yd-analyse ydid:taskgrp:000000:83587010-5e26-4174-92a7-c7cc2612638d:1 ydid:wrkrpool:000000:3666e4c5-382e-4512-a2c7-33dbb839f75
+yd-compare ydid:taskgrp:000000:83587010-5e26-4174-92a7-c7cc2612638d:1 ydid:wrkrpool:000000:3666e4c5-382e-4512-a2c7-33dbb839f75
 ```
 
 The command checks if the **Run Specification** of a Task Group matches the properties of the Worker Pools and their registered Nodes and Workers, meaning there are Workers in the Worker Pool that could be claimed by the Task Group and that the Worker Pool would be a candidate for scaling up to meet the demands of the Task Group.
 
-A detailed matching report showing the match against each specific property is created, which can be used to determine which properties are preventing a Worker Pool match.
+A detailed matching report showing the comparison against each specific property is created, which can be used to determine which properties are preventing a Worker Pool match.
 
 The match status of a Worker Pool falls into one of four categories:
 

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3}/pyproject.toml

@@ -42,10 +42,10 @@
 
 [project.scripts]
     yd-abort = "yellowdog_cli.abort:main"
-    yd-analyse = "yellowdog_cli.analyse:main"
     yd-boost = "yellowdog_cli.boost:main"
     yd-cancel = "yellowdog_cli.cancel:main"
     yd-cloudwizard = "yellowdog_cli.cloudwizard:main"
+    yd-compare = "yellowdog_cli.compare:main"
     yd-create = "yellowdog_cli.create:main"
     yd-delete = "yellowdog_cli.delete:main"
     yd-download = "yellowdog_cli.download:main"
@@ -60,8 +60,8 @@
     yd-resize = "yellowdog_cli.resize:main"
     yd-show = "yellowdog_cli.show:main"
     yd-shutdown = "yellowdog_cli.shutdown:main"
-    yd-submit = "yellowdog_cli.submit:main"
     yd-start = "yellowdog_cli.start:main"
+    yd-submit = "yellowdog_cli.submit:main"
     yd-terminate = "yellowdog_cli.terminate:main"
     yd-upload = "yellowdog_cli.upload:main"
     yd-version = "yellowdog_cli.version:main"

yellowdog_python_examples-7.15.3/yellowdog_cli/__init__.py

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

yellowdog_python_examples-7.15.2/yellowdog_cli/analyse.py → yellowdog_python_examples-7.15.3/yellowdog_cli/compare.py

@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 """
-A script to analyse task groups and check for matching worker pools.
+A script to compare work requirements and task groups with worker pools,
+and check for matches.
 """
 
 from dataclasses import dataclass
@@ -130,7 +131,7 @@ class MatchReport:
         else:
             match_str = "NON-MATCHING"
         print_log(
-            f"Detailed report for {match_str} ({self.worker_pool_status}) worker pool "
+            f"Detailed comparison report for {match_str} ({self.worker_pool_status}) worker pool "
             f"'{self.worker_pool_name}' ({self.worker_pool_id})",
             override_quiet=True,
         )
@@ -607,12 +608,12 @@ def _get_worker_pool_by_id(worker_pool_id) -> WorkerPool:
             )
 
 
-def _analyse_task_group(task_group: TaskGroup, worker_pools: WorkerPools):
+def _compare_task_group(task_group: TaskGroup, worker_pools: WorkerPools):
     """
-    Analyse a Task Group.
+    Compare a Task Group.
     """
     print_log(
-        f"Analysing Task Group '{task_group.name}' ({task_group.id})",
+        f"Comparing Task Group '{task_group.name}' ({task_group.id})",
         override_quiet=True,
     )
 
@@ -652,7 +653,7 @@ def _analyse_task_group(task_group: TaskGroup, worker_pools: WorkerPools):
     for match_report in match_reports:
         match_report.print_detailed_report()
 
-    print_log("Task Group analysis complete")
+    print_log("Task Group comparison complete")
 
 
 @main_wrapper
@@ -670,7 +671,7 @@ def main():
 
     # Task group
     if get_ydid_type(ARGS_PARSER.wr_or_tg_id) == YDIDType.TASK_GROUP:
-        _analyse_task_group(
+        _compare_task_group(
             _get_task_group_by_id(ARGS_PARSER.wr_or_tg_id), worker_pools
         )
 
@@ -678,12 +679,12 @@ def main():
     elif get_ydid_type(ARGS_PARSER.wr_or_tg_id) == YDIDType.WORK_REQUIREMENT:
         work_requirement = _get_work_requirement_by_id(ARGS_PARSER.wr_or_tg_id)
         print_log(
-            f"Analysing all Task Groups in Work Requirement '{work_requirement.name}' "
+            f"Comparing all Task Groups in Work Requirement '{work_requirement.name}' "
             f"({work_requirement.id})",
             override_quiet=True,
         )
         for task_group in work_requirement.taskGroups:
-            _analyse_task_group(task_group, worker_pools)
+            _compare_task_group(task_group, worker_pools)
 
     else:
         raise Exception(

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3}/yellowdog_cli/utils/args.py

@@ -115,7 +115,7 @@ class CLIParser:
         )
 
         # Module-specific argument sets
-        if not any(module in sys.argv[0] for module in ["analyse"]):
+        if not any(module in sys.argv[0] for module in ["compare"]):
             parser.add_argument(
                 "--variable",
                 "-v",
@@ -137,7 +137,7 @@ class CLIParser:
                 "cloudwizard",
                 "follow",
                 "list",
-                "analyse",
+                "compare",
             ]
         ):
             self.namespace_required = True
@@ -1121,13 +1121,13 @@ class CLIParser:
                 ),
             )
 
-        if "analyse" in sys.argv[0]:
+        if "compare" in sys.argv[0]:
             parser.add_argument(
                 "wr_or_tg_id",
                 metavar="<work-requirement-or-task-group-ID>",
                 type=str,
                 help=(
-                    "the YellowDog ID of the work requirement or task group to be analysed"
+                    "the YellowDog ID of the work requirement or task group to be compared"
                 ),
             )
             parser.add_argument(
@@ -1135,7 +1135,7 @@ class CLIParser:
                 metavar="<worker-pool-ID>",
                 type=str,
                 nargs="+",
-                help="the YellowDog ID(s) of the worker pool(s) to analyse",
+                help="the YellowDog ID(s) of the worker pool(s) to compare",
             )
 
         self.args = parser.parse_args()
@@ -1681,9 +1681,9 @@ def lookup_module_description(module_name: str) -> Optional[str]:
         suffix = "boosting Allowances"
     elif "show" in module_name:
         suffix = "showing the JSON details of entities referenced by their YDIDs"
-    elif "analyse" in module_name:
+    elif "compare" in module_name:
         suffix = (
-            "analysing if a work requirement or single task group is matched by "
+            "comparing whether a work requirement or task group is matched by "
             "workers in the specified worker pools"
         )
 

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3}/yellowdog_cli/utils/follow_utils.py

@@ -95,8 +95,12 @@ def follow_events(ydid: str, ydid_type: YDIDType):
         )
 
         if response.status_code != 200:
-            print_error(f"'{ydid}': {response.json()['message']}")
-            return
+            try:
+                error_text = response.json()["message"]
+            except:
+                error_text = "(JSON error cannot be decoded)"
+            print_error(f"'{ydid}': {error_text}")
+            break
 
         if response.encoding is None:
             response.encoding = "utf-8"

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: yellowdog-python-examples
-Version: 7.15.2
+Version: 7.15.3
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 Project-URL: Homepage, https://github.com/yellowdog/python-examples

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3}/yellowdog_python_examples.egg-info/SOURCES.txt

@@ -14,10 +14,10 @@ tests/test_variable_processing.py
 yellowdog_cli/__init__.py
 yellowdog_cli/abort.py
 yellowdog_cli/admin.py
-yellowdog_cli/analyse.py
 yellowdog_cli/boost.py
 yellowdog_cli/cancel.py
 yellowdog_cli/cloudwizard.py
+yellowdog_cli/compare.py
 yellowdog_cli/create.py
 yellowdog_cli/delete.py
 yellowdog_cli/download.py

{yellowdog_python_examples-7.15.2 → yellowdog_python_examples-7.15.3}/yellowdog_python_examples.egg-info/entry_points.txt

@@ -1,9 +1,9 @@
 [console_scripts]
 yd-abort = yellowdog_cli.abort:main
-yd-analyse = yellowdog_cli.analyse:main
 yd-boost = yellowdog_cli.boost:main
 yd-cancel = yellowdog_cli.cancel:main
 yd-cloudwizard = yellowdog_cli.cloudwizard:main
+yd-compare = yellowdog_cli.compare:main
 yd-create = yellowdog_cli.create:main
 yd-delete = yellowdog_cli.delete:main
 yd-download = yellowdog_cli.download:main

yellowdog_python_examples-7.15.2/yellowdog_cli/__init__.py

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