bluer-objects 6.34.1__tar.gz → 6.36.1__tar.gz

{bluer_objects-6.34.1/bluer_objects.egg-info → bluer_objects-6.36.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_objects
-Version: 6.34.1
+Version: 6.36.1
 Summary: 🌀 data objects for Bash.
 Home-page: https://github.com/kamangir/bluer-objects
 Author: Arash Abadpour (Kamangir)
@@ -53,6 +53,6 @@ Also home to [blue README](https://github.com/kamangir/bluer-objects/blob/main/b
 
 [![pylint](https://github.com/kamangir/bluer-objects/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/bluer-objects/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/pytest.yml) [![bashtest](https://github.com/kamangir/bluer-objects/actions/workflows/bashtest.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/bashtest.yml) [![PyPI version](https://img.shields.io/pypi/v/bluer-objects.svg)](https://pypi.org/project/bluer-objects/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/bluer-objects)](https://pypistats.org/packages/bluer-objects)
 
-built by 🌀 [`bluer_options-5.28.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌀 [`bluer_objects-6.34.1`](https://github.com/kamangir/bluer-objects).
+built by 🌀 [`bluer_options-5.28.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌀 [`bluer_objects-6.36.1`](https://github.com/kamangir/bluer-objects).
 
 built by 🌀 [`blueness-3.96.1`](https://github.com/kamangir/blueness).

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/README.md

@@ -19,4 +19,4 @@ Also home to [blue README](./bluer_objects/README/).
 
 [![pylint](https://github.com/kamangir/bluer-objects/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/bluer-objects/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/pytest.yml) [![bashtest](https://github.com/kamangir/bluer-objects/actions/workflows/bashtest.yml/badge.svg)](https://github.com/kamangir/bluer-objects/actions/workflows/bashtest.yml) [![PyPI version](https://img.shields.io/pypi/v/bluer-objects.svg)](https://pypi.org/project/bluer-objects/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/bluer-objects)](https://pypistats.org/packages/bluer-objects)
 
-built by 🌀 [`bluer_options-5.28.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌀 [`bluer_objects-6.34.1`](https://github.com/kamangir/bluer-objects).
+built by 🌀 [`bluer_options-5.28.1`](https://github.com/kamangir/awesome-bash-cli), based on 🌀 [`bluer_objects-6.36.1`](https://github.com/kamangir/bluer-objects).

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/alias.sh

@@ -8,9 +8,9 @@ alias @gif=abcli_gif
 
 alias @assets=abcli_assets
 
-alias @cache=abcli_cache
-alias @ref="abcli_cache read"
-alias @tags=abcli_mlflow_tags
+alias @cache=bluer_objects_mlflow_cache
+alias @ref="bluer_objects_mlflow_cache read"
+alias @tags=bluer_objects_mlflow_tags
 
 alias @clone=bluer_objects_clone
 alias @cp=bluer_objects_clone
@@ -21,9 +21,9 @@ alias @host=abcli_host
 
 alias @ls=bluer_ai_ls
 
-alias @metadata=abcli_metadata
+alias @metadata=bluer_objects_metadata
 
-alias @mlflow=abcli_mlflow
+alias @mlflow=bluer_objects_mlflow
 
 alias @mysql=abcli_mysql
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/clone.sh

@@ -36,12 +36,12 @@ function bluer_objects_clone() {
     fi
 
     [[ "$clone_tags" == 1 ]] &&
-        abcli_mlflow_tags clone \
+        bluer_objects_mlflow_tags clone \
             $object_1_name \
             $object_2_name
 
     [[ "$do_relate" == 1 ]] &&
-        abcli_mlflow_tags set \
+        bluer_objects_mlflow_tags set \
             $object_2_name \
             cloned.$object_1_name
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/metadata/get.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_metadata_get() {
+function bluer_objects_metadata_get() {
     local options=$1
     local source_type=$(abcli_option_choice "$options" object,path,filename object)
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/metadata/post.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_metadata_post() {
+function bluer_objects_metadata_post() {
     local key=$1
 
     local value=$2

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/metadata.sh

@@ -1,9 +1,9 @@
 #! /usr/bin/env bash
 
-function abcli_metadata() {
+function bluer_objects_metadata() {
     local task=${1:-help}
 
-    local function_name="abcli_metadata_$task"
+    local function_name="bluer_objects_metadata_$task"
     if [[ $(type -t $function_name) == "function" ]]; then
         $function_name "${@:2}"
         return

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/browse.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_browse() {
+function bluer_objects_mlflow_browse() {
     local options=$1
     local browse_experiment=$(abcli_option_int "$options" experiment 0)
 
@@ -15,7 +15,7 @@ function abcli_mlflow_browse() {
     else
         local object_name=$(abcli_clarify_object $2 .)
 
-        local experiment_id=$(abcli_mlflow get_id $object_name)
+        local experiment_id=$(bluer_objects_mlflow get_id $object_name)
         if [ -z "$experiment_id" ]; then
             abcli_log_error "@mlflow: browse: $object_name: object not found."
             return 1
@@ -25,7 +25,7 @@ function abcli_mlflow_browse() {
         url="$url/experiments/$experiment_id"
 
         if [[ "$browse_experiment" == 0 ]]; then
-            local last_run_id=$(abcli_mlflow get_run_id $object_name --count 1)
+            local last_run_id=$(bluer_objects_mlflow get_run_id $object_name --count 1)
             abcli_log "last run id: $last_run_id"
 
             url="$url/runs/$last_run_id"

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/cache.sh

@@ -1,13 +1,13 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_cache() {
+function bluer_objects_mlflow_cache() {
     local task=$1
 
     local keyword=$2
 
     if [ "$task" == "read" ]; then
 
-        abcli_mlflow_tags get \
+        bluer_objects_mlflow_tags get \
             $keyword \
             --tag referent \
             "${@:3}"
@@ -18,7 +18,7 @@ function abcli_mlflow_cache() {
     if [ "$task" == "write" ]; then
         local value=$3
 
-        abcli_mlflow_tags set \
+        bluer_objects_mlflow_tags set \
             $keyword \
             referent=$value \
             "${@:4}"

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/list_registered_models.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_list_registered_models() {
+function bluer_objects_mlflow_list_registered_models() {
     local options=$1
 
     python3 -m bluer_objects.mlflow \

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/log_artifacts.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_log_artifacts() {
+function bluer_objects_mlflow_log_artifacts() {
     local object_name=$(abcli_clarify_object $1 .)
 
     python3 -m bluer_objects.mlflow \

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/log_run.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_log_run() {
+function bluer_objects_mlflow_log_run() {
     local object_name=$(abcli_clarify_object $1 .)
 
     python3 -m bluer_objects.mlflow \

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/run.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_run() {
+function bluer_objects_mlflow_run() {
     local object_name=$(abcli_clarify_object $1 .)
 
     python3 -m bluer_objects.mlflow \

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/tags/clone.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_tags_clone() {
+function bluer_objects_mlflow_tags_clone() {
     local source_object=$(abcli_clarify_object $1 ..)
 
     local destination_object=$(abcli_clarify_object $2 .)

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/tags/get.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_tags_get() {
+function bluer_objects_mlflow_tags_get() {
     local object_name=$(abcli_clarify_object $1 .)
 
     python3 -m bluer_objects.mlflow \

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/tags/search.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_tags_search() {
+function bluer_objects_mlflow_tags_search() {
     local options=$1
     local is_explicit=$(abcli_option_int "$options" explicit 0)
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/tags/set.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_tags_set() {
+function bluer_objects_mlflow_tags_set() {
     local object_name=$(abcli_clarify_object $1 .)
 
     local tags=$2

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/tags.sh

@@ -1,9 +1,9 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_tags() {
+function bluer_objects_mlflow_tags() {
     local task=$1
 
-    local function_name=abcli_mlflow_tags_$task
+    local function_name=bluer_objects_mlflow_tags_$task
     if [[ $(type -t $function_name) == "function" ]]; then
         $function_name "${@:2}"
         return

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/test.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/env bash
 
-function abcli_mlflow_test() {
+function bluer_objects_mlflow_test() {
     local options=$1
     local do_dryrun=$(abcli_option_int "$options" dryrun 0)
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow/transition.sh

@@ -2,7 +2,7 @@
 
 export ABCLI_MLFLOW_STAGES="Staging|Production|Archived"
 
-function abcli_mlflow_transition() {
+function bluer_objects_mlflow_transition() {
     local options=$1
     local model_name=$(abcli_option "$options" model)
     local stage_name=$(abcli_option_choice "$options" $(echo $ABCLI_MLFLOW_STAGES | tr \| ,) Staging)

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/mlflow.sh

@@ -2,10 +2,10 @@
 
 export MLFLOW_TRACKING_URI=$HOME/mlruns
 
-function abcli_mlflow() {
+function bluer_objects_mlflow() {
     local task=$1
 
-    local function_name=abcli_mlflow_$task
+    local function_name=bluer_objects_mlflow_$task
     if [[ $(type -t $function_name) == "function" ]]; then
         $function_name "${@:2}"
         return

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/publish.sh

@@ -11,7 +11,7 @@ function bluer_ai_publish() {
     [[ "$do_download" == 1 ]] &&
         bluer_objects_download - $object_name
 
-    abcli_mlflow_tags set $object_name published
+    bluer_objects_mlflow_tags set $object_name published
 
     local public_object_name=$(abcli_option "$options" as $object_name)
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/tests/metadata.sh

@@ -11,21 +11,21 @@ function test_bluer_objects_metadata() {
         local value=$(abcli_string_random)
 
         [[ "$post_func" == 1 ]] &&
-            abcli metadata post \
+            bluer_objects_metadata post \
                 $key $value \
                 filename \
                 $filename \
                 --verbose 1
 
         [[ "$post_func" == 2 ]] &&
-            abcli metadata post \
+            bluer_objects_metadata post \
                 $key $value \
                 object,filename=metadata.yaml \
                 $object_name \
                 --verbose 1
 
         [[ "$post_func" == 3 ]] &&
-            abcli metadata post \
+            bluer_objects_metadata post \
                 $key $value \
                 path,filename=metadata.yaml \
                 $object_path \
@@ -33,17 +33,17 @@ function test_bluer_objects_metadata() {
 
         for get_func in {1..3}; do
             [[ "$get_func" == 1 ]] &&
-                returned_value=$(abcli metadata get \
+                returned_value=$(bluer_objects_metadata get \
                     key=$key,filename \
                     $filename)
 
             [[ "$get_func" == 2 ]] &&
-                returned_value=$(abcli metadata get \
+                returned_value=$(bluer_objects_metadata get \
                     key=$key,filename=metadata.yaml,object \
                     $object_name)
 
             [[ "$get_func" == 3 ]] &&
-                returned_value=$(abcli metadata get \
+                returned_value=$(bluer_objects_metadata get \
                     key=$key,filename=metadata.yaml,path \
                     $object_path)
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/tests/mlflow_cache.sh

@@ -4,11 +4,11 @@ function test_bluer_objects_mlflow_cache() {
     local keyword="test-keyword-$(abcli_string_timestamp_short)"
     local value="test-value-$(abcli_string_timestamp_short)"
 
-    abcli mlflow cache write \
+    bluer_objects_mlflow cache write \
         $keyword $value
     [[ $? -ne 0 ]] && return 1
 
     abcli_assert \
-        $(abcli mlflow cache read $keyword) \
+        $(bluer_objects_mlflow cache read $keyword) \
         $value
 }

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/tests/mlflow_logging.sh

@@ -3,10 +3,10 @@
 function test_bluer_objects_mlflow_logging() {
     local object_name="test-object-$(abcli_string_timestamp_short)"
 
-    abcli clone \
+    bluer_objects_clone \
         upload \
         vanwatch-mlflow-validation-2024-09-23-10673 \
         "$object_name"
 
-    abcli_mlflow rm $object_name
+    bluer_objects_mlflow rm $object_name
 }

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/tests/mlflow_tags.sh

@@ -5,25 +5,25 @@ function test_bluer_objects_mlflow_tags_validation() {
     local tag="test-tag-$(abcli_string_timestamp_short)"
     local value="test-value-$(abcli_string_timestamp_short)"
 
-    abcli mlflow tags set \
+    bluer_objects_mlflow tags set \
         $object_name \
         $tag=$value
     [[ $? -ne 0 ]] && return 1
 
     abcli_assert \
-        "$(abcli mlflow tags get $object_name --tag $tag)" \
+        "$(bluer_objects_mlflow tags get $object_name --tag $tag)" \
         $value
     [[ $? -ne 0 ]] && return 1
 
     abcli_assert \
-        "$(abcli mlflow tags get $object_name --tag some-tag)" \
+        "$(bluer_objects_mlflow tags get $object_name --tag some-tag)" \
         - empty
 }
 
 function test_bluer_objects_mlflow_tags_search() {
     local options=$1
 
-    abcli_mlflow_tags search \
+    bluer_objects_mlflow_tags search \
         cloned.firms_area-template-v1=True \
         --log 0
 }

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/tests/mlflow_test.sh

@@ -3,5 +3,5 @@
 function test_bluer_objects_mlflow_test() {
     local options=$1
 
-    abcli_mlflow_test "$@"
+    bluer_objects_mlflow_test "$@"
 }

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/.abcli/upload.sh

@@ -16,6 +16,6 @@ function bluer_objects_upload() {
     [[ $? -ne 0 ]] && return 1
 
     if [[ -z "$filename" ]]; then
-        abcli_mlflow_log_run $object_name
+        bluer_objects_mlflow_log_run $object_name
     fi
 }

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/__init__.py

@@ -4,7 +4,7 @@ ICON = "🌀"
 
 DESCRIPTION = f"{ICON} data objects for Bash."
 
-VERSION = "6.34.1"
+VERSION = "6.36.1"
 
 REPO_NAME = "bluer-objects"
 

{bluer_objects-6.34.1 → bluer_objects-6.36.1}/bluer_objects/help/functions.py

@@ -3,6 +3,8 @@ from bluer_ai.help.generic import help_functions as generic_help_functions
 from bluer_objects import ALIAS
 from bluer_objects.help.clone import help_clone
 from bluer_objects.help.download import help_download
+from bluer_objects.help.metadata import help_functions as help_metadata
+from bluer_objects.help.mlflow import help_functions as help_mlflow
 from bluer_objects.help.upload import help_upload
 
 help_functions = generic_help_functions(plugin_name=ALIAS)
@@ -11,6 +13,8 @@ help_functions.update(
     {
         "clone": help_clone,
         "download": help_download,
+        "metadata": help_metadata,
+        "mlflow": help_mlflow,
         "upload": help_upload,
     }
 )

bluer_objects-6.36.1/bluer_objects/help/metadata.py

@@ -0,0 +1,152 @@
+from typing import List
+
+from bluer_options.terminal import show_usage, xtra
+
+
+def help_get(
+    tokens: List[str],
+    mono: bool,
+) -> str:
+    # ---
+    options = "".join(
+        [
+            xtra("delim=+,dict.keys,dict.values,", mono=mono),
+            "filename,key=<key>",
+        ]
+    )
+    usage_1 = show_usage(
+        [
+            "@metadata",
+            "get",
+            f"[{options}]",
+            "<filename.yaml>",
+        ],
+        "get <filename.yaml>[<key>]",
+        mono=mono,
+    )
+
+    # ---
+    options = "".join(
+        [
+            xtra("delim=+,dict.keys,dict.values,filename=<metadata.yaml>,", mono=mono),
+            "key=<key>,object",
+        ]
+    )
+    usage_2 = show_usage(
+        [
+            "@metadata",
+            "get",
+            f"[{options}]",
+            "[.|<object-name>]",
+        ],
+        "get <object-name>/metadata[<key>]",
+        mono=mono,
+    )
+
+    # ---
+    options = "".join(
+        [
+            xtra("delim=+,dict.keys,dict.values,filename=<metadata.yaml>,", mono=mono),
+            "key=<key>,path",
+        ]
+    )
+    usage_3 = show_usage(
+        [
+            "@metadata",
+            "get",
+            f"[{options}]",
+            "<path>",
+        ],
+        "get <path>/metadata[<key>]",
+        mono=mono,
+    )
+
+    return "\n".join(
+        [
+            usage_1,
+            usage_2,
+            usage_3,
+        ]
+    )
+
+
+def help_post(
+    tokens: List[str],
+    mono: bool,
+) -> str:
+    args = ["[--verbose 1]"]
+
+    # ---
+    options = "filename"
+
+    usage_1 = show_usage(
+        [
+            "@metadata",
+            "post",
+            "<key>",
+            "<value>",
+            f"{options}",
+            "<filename.yaml>",
+        ]
+        + args,
+        "<filename.yaml>[<key>] = <value>",
+        mono=mono,
+    )
+
+    # ---
+    options = "".join(
+        [
+            "object",
+            xtra(",filename=<metadata.yaml>", mono=mono),
+        ]
+    )
+
+    usage_2 = show_usage(
+        [
+            "@metadata",
+            "post",
+            "<key>",
+            "<value>",
+            f"{options}",
+            "[.|<object-name>]",
+        ]
+        + args,
+        "<object-name>[<key>] = <value>",
+        mono=mono,
+    )
+
+    # ---
+    options = "".join(
+        [
+            "path",
+            xtra(",filename=<metadata.yaml>", mono=mono),
+        ]
+    )
+
+    usage_3 = show_usage(
+        [
+            "@metadata",
+            "post",
+            "<key>",
+            "<value>",
+            f"{options}",
+            "<path>",
+        ]
+        + args,
+        "<path>[<key>] = <value>",
+        mono=mono,
+    )
+
+    return "\n".join(
+        [
+            usage_1,
+            usage_2,
+            usage_3,
+        ]
+    )
+
+
+help_functions = {
+    "get": help_get,
+    "post": help_post,
+}