bluer-objects 6.175.1__tar.gz → 6.186.1__tar.gz

{bluer_objects-6.175.1/bluer_objects.egg-info → bluer_objects-6.186.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_objects
-Version: 6.175.1
+Version: 6.186.1
 Summary: 🌀 Object management in Bash.
 Home-page: https://github.com/kamangir/bluer-objects
 Author: Arash Abadpour (Kamangir)
@@ -64,6 +64,6 @@ pip install bluer-objects
 
 [![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 README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.175.1`](https://github.com/kamangir/bluer-objects).
+built by 🌀 [`bluer README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.186.1`](https://github.com/kamangir/bluer-objects).
 
 built by 🌀 [`blueness-3.118.1`](https://github.com/kamangir/blueness).

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/README.md

@@ -30,4 +30,4 @@ pip install bluer-objects
 
 [![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 README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.175.1`](https://github.com/kamangir/bluer-objects).
+built by 🌀 [`bluer README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.186.1`](https://github.com/kamangir/bluer-objects).

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/.abcli/alias.sh

@@ -38,3 +38,5 @@ alias @select=bluer_ai_select
 alias @storage=bluer_ai_storage
 
 alias @upload=bluer_objects_upload
+
+alias @url=bluer_objects_url

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/.abcli/tests/help.sh

@@ -77,6 +77,9 @@ function test_bluer_objects_help() {
         \
         "@upload" \
         \
+        "@url" \
+        "@url is_accessible" \
+        \
         "@wait" \
         \
         "bluer_objects"; do

bluer_objects-6.186.1/bluer_objects/.abcli/tests/storage_public_upload.sh

@@ -0,0 +1,18 @@
+#! /usr/bin/env bash
+
+function test_bluer_objects_storage_public_upload() {
+    local options=$1
+
+    local object_name=test_bluer_objects_storage_public_upload-$(bluer_ai_string_timestamp_short)
+    local object_path=$ABCLI_OBJECT_ROOT/$object_name
+    mkdir -pv $object_path
+
+    bluer_objects_create_test_asset \
+        $object_name \
+        --depth 1
+    [[ $? -ne 0 ]] && return 1
+
+    bluer_objects_upload \
+        public \
+        $object_name
+}

bluer_objects-6.175.1/bluer_objects/.abcli/tests/storage.sh → bluer_objects-6.186.1/bluer_objects/.abcli/tests/storage_upload_download.sh

@@ -1,9 +1,9 @@
 #! /usr/bin/env bash
 
-function test_bluer_objects_storage() {
+function test_bluer_objects_storage_upload_download() {
     local options=$1
 
-    local object_name=test_bluer_objects_storage-$(bluer_ai_string_timestamp_short)
+    local object_name=test_bluer_objects_storage_upload_download-$(bluer_ai_string_timestamp_short)
     local object_path=$ABCLI_OBJECT_ROOT/$object_name
     mkdir -pv $object_path
 

bluer_objects-6.186.1/bluer_objects/.abcli/tests/url_is_accessible.sh

@@ -0,0 +1,17 @@
+#! /usr/bin/env bash
+
+function test_bluer_objects_url_is_accessible() {
+    local output=$(bluer_objects_url_is_accessible void)
+    [[ "$output" -ne 0 ]] &&
+        return 1
+
+    local url="https://iribnews.ir"
+    [[ "$abcli_is_github_workflow" == true ]] &&
+        url="https://cnn.com"
+
+    output=$(bluer_objects_url_is_accessible $url)
+    [[ "$output" -ne 1 ]] &&
+        return 1
+
+    return 0
+}

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/.abcli/upload.sh

@@ -3,6 +3,7 @@
 function bluer_objects_upload() {
     local options=$1
     local filename=$(bluer_ai_option "$options" filename)
+    local public=$(bluer_ai_option_int "$options" public 0)
 
     local object_name=$(bluer_ai_clarify_object $2 .)
     local object_path=$ABCLI_OBJECT_ROOT/$object_name
@@ -12,10 +13,11 @@ function bluer_objects_upload() {
     python3 -m bluer_objects.storage \
         upload \
         --object_name $object_name \
-        --filename "$filename"
+        --filename "$filename" \
+        --public $public
     [[ $? -ne 0 ]] && return 1
 
-    if [[ -z "$filename" ]]; then
+    if [[ -z "$filename" ]] && [[ "$public" == 0 ]]; then
         bluer_objects_mlflow_log_run $object_name
     fi
 }

bluer_objects-6.186.1/bluer_objects/.abcli/url/is_accessible.sh

@@ -0,0 +1,13 @@
+#! /usr/bin/env bash
+
+function bluer_objects_url_is_accessible() {
+    local url=$1
+    if [[ -z "$url" ]]; then
+        bluer_ai_log_error "url not found."
+        return 1
+    fi
+
+    python3 -m bluer_objects.url \
+        is_accessible \
+        --url $url
+}

bluer_objects-6.186.1/bluer_objects/.abcli/url.sh

@@ -0,0 +1,15 @@
+#! /usr/bin/env bash
+
+function bluer_objects_url() {
+    local task=$1
+
+    local function_name=bluer_objects_url_$task
+    if [[ $(type -t $function_name) == "function" ]]; then
+        $function_name "${@:2}"
+        return
+    fi
+
+    python3 -m bluer_objects.url "$@"
+}
+
+bluer_ai_source_caller_suffix_path /url

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/__init__.py

@@ -4,7 +4,7 @@ ICON = "🌀"
 
 DESCRIPTION = f"{ICON} Object management in Bash."
 
-VERSION = "6.175.1"
+VERSION = "6.186.1"
 
 REPO_NAME = "bluer-objects"
 

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/config.env

@@ -4,5 +4,6 @@ MLFLOW_LOCK_WAIT_FOR_CLEARANCE=3
 MLFLOW_LOCK_WAIT_FOR_EXCLUSIVITY=1
 
 S3_STORAGE_BUCKET=kamangir
+S3_PUBLIC_STORAGE_BUCKET=kamangir-public
 
 BLUER_OBJECTS_STORAGE_INTERFACE=s3

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/env.py

@@ -36,6 +36,7 @@ DUMMY_TEXT = "This is some dummy text. This is some dummy text. This is some dum
 ABCLI_MLFLOW_EXPERIMENT_PREFIX = get_env("ABCLI_MLFLOW_EXPERIMENT_PREFIX")
 
 S3_STORAGE_BUCKET = get_env("S3_STORAGE_BUCKET")
+S3_PUBLIC_STORAGE_BUCKET = get_env("S3_PUBLIC_STORAGE_BUCKET")
 
 S3_STORAGE_ENDPOINT_URL = get_env("S3_STORAGE_ENDPOINT_URL")
 S3_STORAGE_AWS_ACCESS_KEY_ID = get_env("S3_STORAGE_AWS_ACCESS_KEY_ID")

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/help/functions.py

@@ -10,6 +10,7 @@ from bluer_objects.help.ls import help_ls
 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
+from bluer_objects.help.url import help_functions as help_url
 
 help_functions = generic_help_functions(plugin_name=ALIAS)
 
@@ -24,5 +25,6 @@ help_functions.update(
         "metadata": help_metadata,
         "mlflow": help_mlflow,
         "upload": help_upload,
+        "url": help_url,
     }
 )

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/help/upload.py

@@ -7,7 +7,12 @@ def help_upload(
     tokens: List[str],
     mono: bool,
 ) -> str:
-    options = "filename=<filename>"
+    options = "".join(
+        [
+            "filename=<filename>",
+            xtra(",public", mono=mono),
+        ]
+    )
 
     return show_usage(
         [

bluer_objects-6.186.1/bluer_objects/help/url.py

@@ -0,0 +1,23 @@
+from typing import List
+
+from bluer_options.terminal import show_usage
+
+
+def help_is_accessible(
+    tokens: List[str],
+    mono: bool,
+) -> str:
+    return show_usage(
+        [
+            "@url",
+            "is_accessible",
+            "<url>",
+        ],
+        "is <url> accessible?",
+        mono=mono,
+    )
+
+
+help_functions = {
+    "is_accessible": help_is_accessible,
+}

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/WebDAV.py

@@ -86,8 +86,13 @@ class WebDAVInterface(StorageInterface):
         self,
         object_name: str,
         filename: str = "",
+        public: bool = False,
         log: bool = True,
     ) -> bool:
+        if public:
+            logger.error("public not supported.")
+            return False
+
         if filename:
             remote_dir = "/".join([object_name] + filename.split("/")[:-1])
             if not self.mkdir(
@@ -111,5 +116,6 @@ class WebDAVInterface(StorageInterface):
         return super().upload(
             object_name=object_name,
             filename=filename,
+            public=public,
             log=log,
         )

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/WebDAVrequest.py

@@ -278,8 +278,13 @@ class WebDAVRequestInterface(StorageInterface):
         self,
         object_name: str,
         filename: str = "",
+        public: bool = False,
         log: bool = True,
     ) -> bool:
+        if public:
+            logger.error("public not supported.")
+            return False
+
         if filename:
             if not self.mkdir(
                 path="{}/{}".format(
@@ -315,6 +320,7 @@ class WebDAVRequestInterface(StorageInterface):
                 return super().upload(
                     object_name=object_name,
                     filename=filename,
+                    public=public,
                     log=log,
                 )
 
@@ -339,6 +345,7 @@ class WebDAVRequestInterface(StorageInterface):
             if not self.upload(
                 object_name=object_name,
                 filename=filename_.split(object_path, 1)[1],
+                public=public,
                 log=log,
             ):
                 return False

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/WebDAVzip.py

@@ -125,8 +125,13 @@ class WebDAVzipInterface(StorageInterface):
         self,
         object_name: str,
         filename: str = "",
+        public: bool = False,
         log: bool = True,
     ) -> bool:
+        if public:
+            logger.error("public not supported.")
+            return False
+
         object_path = objects.object_path(object_name=object_name)
 
         if not zip(
@@ -149,5 +154,6 @@ class WebDAVzipInterface(StorageInterface):
 
         return super().upload(
             object_name=object_name,
+            public=public,
             log=log,
         )

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/__init__.py

@@ -56,10 +56,12 @@ def ls(
 def upload(
     object_name: str,
     filename: str = "",
+    public: bool = False,
     log: bool = True,
 ) -> bool:
     return interface.upload(
         object_name=object_name,
         filename=filename,
+        public=public,
         log=log,
     )

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/__main__.py

@@ -24,6 +24,12 @@ parser.add_argument(
     type=str,
     default="",
 )
+parser.add_argument(
+    "--public",
+    type=int,
+    default=0,
+    help="0 | 1",
+)
 parser.add_argument(
     "--where",
     type=str,
@@ -80,6 +86,7 @@ elif args.task == "upload":
     success = storage.upload(
         object_name=args.object_name,
         filename=args.filename,
+        public=args.public == 1,
     )
 else:
     success = None

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/base.py

@@ -66,14 +66,16 @@ class StorageInterface:
         self,
         object_name: str,
         filename: str = "",
+        public: bool = False,
         log: bool = True,
     ) -> bool:
         if log:
             logger.info(
-                "{}.upload {}{}".format(
+                "{}.upload {}{}{}".format(
                     self.__class__.__name__,
                     object_name,
                     f"/{filename}" if filename else "",
+                    " [public]" if public else "",
                 )
             )
 

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/storage/s3.py

@@ -225,6 +225,7 @@ class S3Interface(StorageInterface):
         self,
         object_name: str,
         filename: str = "",
+        public: bool = False,
         log: bool = True,
     ) -> bool:
         if filename:
@@ -233,6 +234,10 @@ class S3Interface(StorageInterface):
                 filename=filename,
             )
 
+            bucket_name = (
+                env.S3_PUBLIC_STORAGE_BUCKET if public else env.S3_STORAGE_BUCKET
+            )
+
             try:
                 s3_resource = boto3.resource(
                     "s3",
@@ -241,11 +246,11 @@ class S3Interface(StorageInterface):
                     aws_secret_access_key=env.S3_STORAGE_AWS_SECRET_ACCESS_KEY,
                 )
 
-                bucket = s3_resource.Bucket(env.S3_STORAGE_BUCKET)
+                bucket = s3_resource.Bucket(bucket_name)
 
                 with open(local_path, "rb") as fp:
                     bucket.put_object(
-                        ACL="private",
+                        ACL="public-read" if public else "private",
                         Body=fp,
                         Key=f"{object_name}/{filename}",
                     )
@@ -253,9 +258,21 @@ class S3Interface(StorageInterface):
                 logger.error(e)
                 return False
 
+            if public:
+
+                logger.info(
+                    "🔗 https://{}.{}/{}/{}".format(
+                        bucket_name,
+                        env.S3_STORAGE_ENDPOINT_URL.split("https://", 1)[1],
+                        object_name,
+                        filename,
+                    )
+                )
+
             return super().upload(
                 object_name=object_name,
                 filename=filename,
+                public=public,
                 log=log,
             )
 
@@ -277,6 +294,7 @@ class S3Interface(StorageInterface):
             if not self.upload(
                 object_name=object_name,
                 filename=filename_.split(object_path, 1)[1],
+                public=public,
                 log=log,
             ):
                 return False

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects/tests/test_env.py

@@ -17,6 +17,7 @@ def test_bluer_objects_env():
     assert env.ABCLI_MLFLOW_EXPERIMENT_PREFIX
 
     assert env.S3_STORAGE_BUCKET
+    assert env.S3_PUBLIC_STORAGE_BUCKET
 
     assert env.S3_STORAGE_ENDPOINT_URL
     assert env.S3_STORAGE_AWS_ACCESS_KEY_ID

bluer_objects-6.186.1/bluer_objects/tests/test_url_is_accessible.py

@@ -0,0 +1,11 @@
+from bluer_objects.url.functions import is_accessible
+from bluer_ai.env import abcli_is_github_workflow
+
+
+def test_url_is_accessible():
+    success = is_accessible("void")
+    assert not success
+
+    url = "https://cnn.com" if abcli_is_github_workflow else "https://iribnews.ir"
+    success = is_accessible(url)
+    assert success

bluer_objects-6.186.1/bluer_objects/url/__init__.py

@@ -0,0 +1 @@
+

bluer_objects-6.186.1/bluer_objects/url/__main__.py

@@ -0,0 +1,31 @@
+import argparse
+
+from blueness import module
+from blueness.argparse.generic import sys_exit
+
+from bluer_objects import NAME
+from bluer_objects.url.functions import is_accessible
+from bluer_objects.logger import logger
+
+NAME = module.name(__file__, NAME)
+
+parser = argparse.ArgumentParser(NAME)
+parser.add_argument(
+    "task",
+    type=str,
+    help="is_accessible",
+)
+parser.add_argument(
+    "--url",
+    type=str,
+)
+args = parser.parse_args()
+
+success = False
+if args.task == "is_accessible":
+    success = True
+    print(int(is_accessible(args.url)))
+else:
+    success = None
+
+sys_exit(logger, NAME, args.task, success)

bluer_objects-6.186.1/bluer_objects/url/functions.py

@@ -0,0 +1,11 @@
+import requests
+
+from bluer_objects.logger import logger
+
+
+def is_accessible(url) -> bool:
+    try:
+        response = requests.get(url)
+        return response.status_code == 200
+    except:
+        return False

{bluer_objects-6.175.1 → bluer_objects-6.186.1/bluer_objects.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bluer_objects
-Version: 6.175.1
+Version: 6.186.1
 Summary: 🌀 Object management in Bash.
 Home-page: https://github.com/kamangir/bluer-objects
 Author: Arash Abadpour (Kamangir)
@@ -64,6 +64,6 @@ pip install bluer-objects
 
 [![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 README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.175.1`](https://github.com/kamangir/bluer-objects).
+built by 🌀 [`bluer README`](https://github.com/kamangir/bluer-objects/tree/main/bluer_objects/README), based on 🌀 [`bluer_objects-6.186.1`](https://github.com/kamangir/bluer-objects).
 
 built by 🌀 [`blueness-3.118.1`](https://github.com/kamangir/blueness).

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/bluer_objects.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ bluer_objects/.abcli/object.sh
 bluer_objects/.abcli/select.sh
 bluer_objects/.abcli/storage.sh
 bluer_objects/.abcli/upload.sh
+bluer_objects/.abcli/url.sh
 bluer_objects/.abcli/metadata/get.sh
 bluer_objects/.abcli/metadata/post.sh
 bluer_objects/.abcli/mlflow/browse.sh
@@ -74,8 +75,11 @@ bluer_objects/.abcli/tests/mlflow_lock.sh
 bluer_objects/.abcli/tests/mlflow_logging.sh
 bluer_objects/.abcli/tests/mlflow_tags.sh
 bluer_objects/.abcli/tests/mlflow_test.sh
-bluer_objects/.abcli/tests/storage.sh
+bluer_objects/.abcli/tests/storage_public_upload.sh
+bluer_objects/.abcli/tests/storage_upload_download.sh
+bluer_objects/.abcli/tests/url_is_accessible.sh
 bluer_objects/.abcli/tests/version.sh
+bluer_objects/.abcli/url/is_accessible.sh
 bluer_objects/README/__init__.py
 bluer_objects/README/functions.py
 bluer_objects/README/items.py
@@ -103,6 +107,7 @@ bluer_objects/help/host.py
 bluer_objects/help/ls.py
 bluer_objects/help/metadata.py
 bluer_objects/help/upload.py
+bluer_objects/help/url.py
 bluer_objects/help/mlflow/__init__.py
 bluer_objects/help/mlflow/cache.py
 bluer_objects/help/mlflow/lock.py
@@ -166,4 +171,8 @@ bluer_objects/tests/test_storage_s3.py
 bluer_objects/tests/test_storage_webdav_request.py
 bluer_objects/tests/test_storage_webdav_zip.py
 bluer_objects/tests/test_testing.py
-bluer_objects/tests/test_version.py
+bluer_objects/tests/test_url_is_accessible.py
+bluer_objects/tests/test_version.py
+bluer_objects/url/__init__.py
+bluer_objects/url/__main__.py
+bluer_objects/url/functions.py

{bluer_objects-6.175.1 → bluer_objects-6.186.1}/setup.py

@@ -22,6 +22,7 @@ setup(
         f"{NAME}.storage",
         f"{NAME}.testing",
         f"{NAME}.tests",
+        f"{NAME}.url",
     ],
     include_package_data=True,
     package_data={