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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_objects
-Version: 6.34.1
+Version: 6.35.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.35.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.35.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.35.1`](https://github.com/kamangir/bluer-objects).

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

@@ -21,7 +21,7 @@ alias @host=abcli_host
 
 alias @ls=bluer_ai_ls
 
-alias @metadata=abcli_metadata
+alias @metadata=bluer_objects_metadata
 
 alias @mlflow=abcli_mlflow
 

{bluer_objects-6.34.1 → bluer_objects-6.35.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.35.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.35.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.35.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.35.1}/bluer_objects/__init__.py

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

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

@@ -3,6 +3,7 @@ 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.upload import help_upload
 
 help_functions = generic_help_functions(plugin_name=ALIAS)
@@ -11,6 +12,7 @@ help_functions.update(
     {
         "clone": help_clone,
         "download": help_download,
+        "metadata": help_metadata,
         "upload": help_upload,
     }
 )

bluer_objects-6.35.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,
+}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_objects
-Version: 6.34.1
+Version: 6.35.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.35.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.35.1}/bluer_objects.egg-info/SOURCES.txt

@@ -92,6 +92,7 @@ bluer_objects/help/__main__.py
 bluer_objects/help/clone.py
 bluer_objects/help/download.py
 bluer_objects/help/functions.py
+bluer_objects/help/metadata.py
 bluer_objects/help/upload.py
 bluer_objects/host/__init__.py
 bluer_objects/host/__main__.py