yellowdog-python-examples 7.20.0__tar.gz → 7.20.2__tar.gz

{yellowdog_python_examples-7.20.0/yellowdog_python_examples.egg-info → yellowdog_python_examples-7.20.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.20.0
+Version: 7.20.2
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 License-Expression: Apache-2.0

{yellowdog_python_examples-7.20.0 → yellowdog_python_examples-7.20.2}/README.md

@@ -133,7 +133,7 @@
    * [yd-compare](#yd-compare)
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: pwt, at: Fri Aug 15 15:49:13 BST 2025 -->
+<!-- Added by: pwt, at: Thu Oct  2 10:08:27 BST 2025 -->
 
 <!--te-->
 
@@ -235,39 +235,52 @@ Both of the installation methods above will install a number of **`yd-`** comman
 Commands are run from the command line. Invoking any command with the `--help` or `-h` option will display the command line options applicable to that command, e.g.:
 
 ```text
- % yd-cancel --help
-usage: yd-cancel [-h] [--docs] [--config <config_file.toml>] [--key <app-key>]
-                 [--secret <app-secret>] [--namespace <namespace>] [--tag <tag>] [--url <url>]
-                 [--variable <var1=v1>] [--quiet] [--debug] [--pac] [--abort] [--follow]
-                 [--interactive] [--yes]
+ % yd-cancel -h
+usage: yd-cancel [-h] [--docs] [--config <config_file.toml>] [--key <app-key-id>] [--secret <app-key-secret>]
+                 [--url <url>] [--debug] [--pac] [--no-format] [--quiet] [--env-override] [--print-pid]
+                 [--variable <var1=v1>] [--namespace [<namespace>]] [--tag [<tag>]] [--abort] [--follow]
+                 [--interactive] [--yes] [--raw-events]
+                 [<work-requirement-name-or-ID> ...]
 
 YellowDog command line utility for cancelling Work Requirements
 
+positional arguments:
+  <work-requirement-name-or-ID>
+                        the name(s) or YellowDog ID(s) of the work requirement(s) to be cancelled; can also supply
+                        task IDs
+
 optional arguments:
   -h, --help            show this help message and exit
   --docs                provide a link to the documentation for this version
   --config <config_file.toml>, -c <config_file.toml>
-                        configuration file in TOML format; default is 'config.toml' in the current
+                        configuration file in TOML format; the default to use is 'config.toml' in the current
                         directory
-  --key <app-key>, -k <app-key>
-                        the YellowDog Application key
-  --secret <app-secret>, -s <app-secret>
-                        the YellowDog Application secret
-  --namespace <namespace>, -n <namespace>
-                        the namespace to use when creating and identifying entities
-  --tag <tag>, -t <tag>
-                        the tag to use for tagging and naming entities
+  --key <app-key-id>, -k <app-key-id>
+                        the application key ID
+  --secret <app-key-secret>, -s <app-key-secret>
+                        the application key secret
   --url <url>, -u <url>
-                        the URL of the YellowDog Platform API
-  --variable <var1=v1>, -v <var1=v1>
-                        user-defined variable substitutions; can be supplied multiple times
-  --quiet, -q           suppress (non-error, non-interactive) status and progress messages
-  --debug               print a stack trace (etc.) on error
+                        the YellowDog Platform API URL (defaults to 'https://api.yellowdog.ai')
+  --debug               display the Python stack trace on error
   --pac                 enable PAC (proxy auto-configuration) support
-  --abort, -a           abort all running tasks with immediate effect
-  --follow, -f          when using --abort, poll until all Tasks have been aborted
-  --interactive, -i     list, and interactively select, items to act on
-  --yes, -y             perform destructive actions without requiring user confirmation
+  --no-format, --nf     disable colouring and text wrapping in command output
+  --quiet, -q           suppress (non-error, non-interactive) status and progress messages
+  --env-override        values in '.env' file override values in the environment
+  --print-pid, --pp     include the process ID of this CLI invocation alongside timestamp in logging messages
+  --variable <var1=v1>, -v <var1=v1>
+                        user-defined variable substitution; the option can be supplied multiple times, one per
+                        variable
+  --namespace [<namespace>], -n [<namespace>]
+                        the namespace to use when specifying entities; this is set to '' if the option is provided
+                        without a value
+  --tag [<tag>], -t [<tag>], --prefix [<tag>]
+                        the tag to use when naming, tagging, or selecting entities, or the prefix (directory) when
+                        used with the object store; this is set to '' if the option is provided without a value
+  --abort, -a           abort running tasks with immediate effect
+  --follow, -f          follow progress after cancelling the work requirement(s)
+  --interactive, -i     list, and interactively select, the items to act on
+  --yes, -y             perform modifying/destructive actions without requiring user confirmation
+  --raw-events          print the raw JSON event stream when following events
 ```
 
 # Configuration
@@ -376,11 +389,11 @@ These options can also be listed by running a command with the `--help` or `-h`
 
 The **environment variables** are as follows:
 
-- `YD_KEY`
-- `YD_SECRET`
+- `YD_KEY` (or `YD_API_KEY_ID`)
+- `YD_SECRET` (or `YD_API_KEY_SECRET`)
+- `YD_URL` (or `YD_API_URL`)
 - `YD_NAMESPACE`
 - `YD_TAG`
-- `YD_URL`
 
 When setting the value of the above properties, a property set on the command line takes precedence over one set via an environment variable, and both take precedence over a value set in a configuration file.
 

yellowdog_python_examples-7.20.2/yellowdog_cli/__init__.py

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

{yellowdog_python_examples-7.20.0 → yellowdog_python_examples-7.20.2}/yellowdog_cli/utils/load_config.py

@@ -33,10 +33,13 @@ from yellowdog_cli.utils.settings import (
     TASK_BATCH_SIZE_DEFAULT,
     TOML_VAR_NESTED_DEPTH,
     YD_KEY,
+    YD_KEY_ALT,
     YD_NAMESPACE,
     YD_SECRET,
+    YD_SECRET_ALT,
     YD_TAG,
     YD_URL,
+    YD_URL_ALT,
 )
 from yellowdog_cli.utils.type_check import check_list, check_str
 from yellowdog_cli.utils.validate_properties import validate_properties
@@ -48,6 +51,16 @@ from yellowdog_cli.utils.variables import (
     process_variable_substitutions_insitu,
 )
 
+# Support for alternative common env. vars; written into the normal vars.
+for norm, alt in [
+    (YD_KEY, YD_KEY_ALT),
+    (YD_SECRET, YD_SECRET_ALT),
+    (YD_URL, YD_URL_ALT),
+]:
+    if os.getenv(norm) is None and os.getenv(alt) is not None:
+        os.environ[norm] = os.getenv(alt)
+        print_log(f"Setting environment variable '{norm}' using value of '{alt}'")
+
 # CLI > YD_CONF > 'config.toml'
 CONFIG_FILE = relpath(
     getenv("YD_CONF", "config.toml")

{yellowdog_python_examples-7.20.0 → yellowdog_python_examples-7.20.2}/yellowdog_cli/utils/misc_utils.py

@@ -252,10 +252,12 @@ def load_dotenv_file():
     unless --env-override option is set.
     Report on YD vars that are taken from .env.
     """
-    dotenv_file = find_dotenv()
+    dotenv_file = find_dotenv(usecwd=True)
     if dotenv_file == "":
         return
 
+    print_log(f"Loading environment variables from '{dotenv_file}'")
+
     dotenv_yd_substitutions = [  # Find 'YD' variables
         f"'{key}'"
         for key in dotenv_values(dotenv_file).keys()
@@ -265,7 +267,7 @@ def load_dotenv_file():
 
     if len(dotenv_yd_substitutions) > 0:
         print_log(
-            f"Adding 'YD' environment variables from '.env' file '{dotenv_file}': "
+            "Adding 'YD' environment variable(s): "
             f"{', '.join(dotenv_yd_substitutions)}"
         )
 

{yellowdog_python_examples-7.20.0 → yellowdog_python_examples-7.20.2}/yellowdog_cli/utils/settings.py

@@ -13,6 +13,11 @@ YD_ENV_VAR_PREFIX = "YD_VAR_"
 ENV_VAR_SUB_PREFIX = "env:"
 RAND_VAR_SIZE = 0xFFF
 
+# Alternative env.var names
+YD_KEY_ALT = "YD_API_KEY_ID"
+YD_SECRET_ALT = "YD_API_KEY_SECRET"
+YD_URL_ALT = "YD_API_URL"
+
 TASK_BATCH_SIZE_DEFAULT = 1000
 MAX_PARALLEL_TASK_BATCH_UPLOAD_THREADS = 1
 MAX_BATCH_SUBMIT_ATTEMPTS = 4  # Initial attempt plus retries

{yellowdog_python_examples-7.20.0 → yellowdog_python_examples-7.20.2}/yellowdog_cli/utils/variables.py

@@ -294,11 +294,33 @@ def process_untyped_variable_substitutions(
         var_name = input_string.replace(
             f"{opening_delimiter}{ENV_VAR_SUB_PREFIX}", ""
         ).replace(closing_delimiter, "")
+        if VAR_DEFAULT_SEPARATOR in var_name:  # Check for a default
+            split_result = var_name.split(VAR_DEFAULT_SEPARATOR)
+            if split_result[0] == "" or len(split_result) != 2:
+                raise Exception(
+                    f"Malformed '<variable>:=<default>' substitution: '{var_name}'"
+                )
+            var_name, var_default = split_result
+        else:
+            var_default = None
         var = os.getenv(var_name, None)
-        if var is not None:
+        if var is not None:  # Matching environment variable
+            if var_default is None:  # Just replace the prefix and the variable name
+                input_string = input_string.replace(
+                    f"{opening_delimiter}{ENV_VAR_SUB_PREFIX}{var_name}{closing_delimiter}",
+                    var,
+                )
+            else:  # Also replace the default separator & value
+                input_string = input_string.replace(
+                    f"{opening_delimiter}{ENV_VAR_SUB_PREFIX}{var_name}"
+                    f"{VAR_DEFAULT_SEPARATOR}{var_default}{closing_delimiter}",
+                    var,
+                )
+        elif var_default is not None:  # Variable not found, but default exists
             input_string = input_string.replace(
-                f"{opening_delimiter}{ENV_VAR_SUB_PREFIX}{var_name}{closing_delimiter}",
-                var,
+                f"{opening_delimiter}{ENV_VAR_SUB_PREFIX}{var_name}"
+                f"{VAR_DEFAULT_SEPARATOR}{var_default}{closing_delimiter}",
+                var_default,
             )
 
     # Create list of variable substitutions with their default values

{yellowdog_python_examples-7.20.0 → yellowdog_python_examples-7.20.2/yellowdog_python_examples.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yellowdog-python-examples
-Version: 7.20.0
+Version: 7.20.2
 Summary: Python CLI commands using the YellowDog Python SDK
 Author-email: YellowDog Limited <support@yellowdog.co>
 License-Expression: Apache-2.0

yellowdog_python_examples-7.20.0/yellowdog_cli/__init__.py

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