bluer-options 5.292.1__tar.gz

bluer_options-5.292.1/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

bluer_options-5.292.1/MANIFEST.in

@@ -0,0 +1 @@
+include requirements.txt

bluer_options-5.292.1/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: bluer_options
+Version: 5.292.1
+Summary: 🌀 Options for Bash.
+Home-page: https://github.com/kamangir/bluer-options
+Author: Arash Abadpour (Kamangir)
+Author-email: arash.abadpour@gmail.com
+License: CC0-1.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Unix Shell
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: blueness
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pymysql
+Requires-Dist: python-dotenv[cli]
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+# 🌀 bluer-options
+
+🌀 `bluer_options` implements an `options` argument for Bash.
+
+## installation
+
+```bash
+pip install bluer_options
+```
+
+if using outside the [`bluer-ai`](https://github.com/kamangir/bluer-ai) ecosystem, add this line to `~/.bash_profile` or `~/.bashrc`,
+
+```bash
+source $(python3 -m bluer_options locate)/.bash/bluer_options.sh
+```
+
+for more refer to 🔻 [giza](https://github.com/kamangir/giza).
+
+## usage
+
+let the function receive one or more `options` arguments (example below) then parse them with `bluer_ai_option`, `bluer_ai_option_int`, and `bluer_ai_option_choice`.
+
+```bash
+function func() {
+    local options=$1
+
+    local var=$(bluer_ai_option "$options" var default)
+    local key=$(bluer_ai_option_int "$options" key 0)
+    local choice=$(bluer_ai_option_choice "$options" value_1,value_2,value_3 default)
+
+    :
+}
+```
+
+this enables the user to call `func` as,
+
+```bash
+func var=12,~key,value_1
+```
+
+all options have defaults and order doesn't matter.
+
+<details>
+<summary>example 1</summary>
+
+here is an example use of an `options` in the [vancouver-watching 🌈](https://github.com/kamangir/vancouver-watching) ingest command:
+
+
+```bash
+ > @help vanwatch ingest
+```
+```bash
+vanwatch \
+	ingest \
+	[area=<area>,count=<-1>,~download,dryrun,~upload] \
+	[-|<object-name>] \
+	[process,count=<-1>,~download,dryrun,gif,model=<model-id>,publish,~upload] \
+	[--detect_objects 0] \
+	[--overwrite 1] \
+	[--verbose 1]
+```
+
+this command takes in an `options`, an `object`, and `args`. an `options` is a string representation of a dictionary, such as,
+
+```bash
+area=<vancouver>,~batch,count=<-1>,dryrun,gif,model=<model-id>,~process,publish,~upload
+```
+
+which is equivalent, in json notation, to,
+
+```json
+{
+    "area": "vancouver",
+    "batch": false,
+    "count": -1,
+    "dryrun": true,
+    "gif": true,
+    "model": "<model-id>",
+    "process": false,
+    "publish": true,
+    "upload": false,
+}
+```
+
+</details>
+
+<details>
+<summary>example 2</summary>
+
+from [reddit](https://www.reddit.com/r/bash/comments/1duw6ac/how_can_i_automate_these_tree_commands_i/)
+
+> How can I automate these tree commands I frequently need to type out?
+I would like to run:
+```bash
+git add .
+git commit -m "Initial "commit"
+git push
+```
+> I got bored of typing them out each time. Can I make an alias or something like "gc" (for git commit). The commit message is always the same "Initial commit".
+
+first, install `bluer-options`. this will also install [`blueness`](https://github.com/kamangir/blueness).
+
+```bash
+pip install bluer_options
+```
+
+then, copy [`example1.sh`](https://github.com/kamangir/bluer-options/blob/main/bluer_options/assets/example1.sh) to your machine and add this line to the end of your `bash_profile`,
+
+```bash
+source <path/to/example1.sh>
+```
+
+now, you have access to the `@git` super command. here is how it works.
+
+1. `@git help` shows usage instructions (see below).
+1. `@git commit` runs the three commands. you can customize the message by running `@git commit <message>`. you can also avoid the push by running `@git commit <message> ~push`.
+1. for any `<task>` other than `commit`, `@git <task> <args>` runs `git <task> <args>`.
+
+```
+ > @git help
+ @git commit [<message>] \
+	~push
+ . git commit with <message> and push.
+@git <command>
+ . git <command>.
+ ```
+
+![image](https://raw.githubusercontent.com/kamangir/assets/main/blue-options/example1.png)
+
+</details>
+
+---
+
+> 🌀 [`blue-options`](https://github.com/kamangir/blue-options) for the [Global South](https://github.com/kamangir/bluer-south).
+
+---
+
+[![pylint](https://github.com/kamangir/bluer-options/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/bluer-options/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/bluer-options/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/bluer-options/actions/workflows/pytest.yml) [![PyPI version](https://img.shields.io/pypi/v/bluer-options.svg)](https://pypi.org/project/bluer-options/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/bluer-options)](https://pypistats.org/packages/bluer-options)
+
+built by 🌀 [`blueness-3.118.1`](https://github.com/kamangir/blueness).

bluer_options-5.292.1/README.md

@@ -0,0 +1,138 @@
+# 🌀 bluer-options
+
+🌀 `bluer_options` implements an `options` argument for Bash.
+
+## installation
+
+```bash
+pip install bluer_options
+```
+
+if using outside the [`bluer-ai`](https://github.com/kamangir/bluer-ai) ecosystem, add this line to `~/.bash_profile` or `~/.bashrc`,
+
+```bash
+source $(python3 -m bluer_options locate)/.bash/bluer_options.sh
+```
+
+for more refer to 🔻 [giza](https://github.com/kamangir/giza).
+
+## usage
+
+let the function receive one or more `options` arguments (example below) then parse them with `bluer_ai_option`, `bluer_ai_option_int`, and `bluer_ai_option_choice`.
+
+```bash
+function func() {
+    local options=$1
+
+    local var=$(bluer_ai_option "$options" var default)
+    local key=$(bluer_ai_option_int "$options" key 0)
+    local choice=$(bluer_ai_option_choice "$options" value_1,value_2,value_3 default)
+
+    :
+}
+```
+
+this enables the user to call `func` as,
+
+```bash
+func var=12,~key,value_1
+```
+
+all options have defaults and order doesn't matter.
+
+<details>
+<summary>example 1</summary>
+
+here is an example use of an `options` in the [vancouver-watching 🌈](https://github.com/kamangir/vancouver-watching) ingest command:
+
+
+```bash
+ > @help vanwatch ingest
+```
+```bash
+vanwatch \
+	ingest \
+	[area=<area>,count=<-1>,~download,dryrun,~upload] \
+	[-|<object-name>] \
+	[process,count=<-1>,~download,dryrun,gif,model=<model-id>,publish,~upload] \
+	[--detect_objects 0] \
+	[--overwrite 1] \
+	[--verbose 1]
+```
+
+this command takes in an `options`, an `object`, and `args`. an `options` is a string representation of a dictionary, such as,
+
+```bash
+area=<vancouver>,~batch,count=<-1>,dryrun,gif,model=<model-id>,~process,publish,~upload
+```
+
+which is equivalent, in json notation, to,
+
+```json
+{
+    "area": "vancouver",
+    "batch": false,
+    "count": -1,
+    "dryrun": true,
+    "gif": true,
+    "model": "<model-id>",
+    "process": false,
+    "publish": true,
+    "upload": false,
+}
+```
+
+</details>
+
+<details>
+<summary>example 2</summary>
+
+from [reddit](https://www.reddit.com/r/bash/comments/1duw6ac/how_can_i_automate_these_tree_commands_i/)
+
+> How can I automate these tree commands I frequently need to type out?
+I would like to run:
+```bash
+git add .
+git commit -m "Initial "commit"
+git push
+```
+> I got bored of typing them out each time. Can I make an alias or something like "gc" (for git commit). The commit message is always the same "Initial commit".
+
+first, install `bluer-options`. this will also install [`blueness`](https://github.com/kamangir/blueness).
+
+```bash
+pip install bluer_options
+```
+
+then, copy [`example1.sh`](./bluer_options/assets/example1.sh) to your machine and add this line to the end of your `bash_profile`,
+
+```bash
+source <path/to/example1.sh>
+```
+
+now, you have access to the `@git` super command. here is how it works.
+
+1. `@git help` shows usage instructions (see below).
+1. `@git commit` runs the three commands. you can customize the message by running `@git commit <message>`. you can also avoid the push by running `@git commit <message> ~push`.
+1. for any `<task>` other than `commit`, `@git <task> <args>` runs `git <task> <args>`.
+
+```
+ > @git help
+ @git commit [<message>] \
+	~push
+ . git commit with <message> and push.
+@git <command>
+ . git <command>.
+ ```
+
+![image](https://raw.githubusercontent.com/kamangir/assets/main/blue-options/example1.png)
+
+</details>
+
+---
+
+> 🌀 [`blue-options`](https://github.com/kamangir/blue-options) for the [Global South](https://github.com/kamangir/bluer-south).
+
+---
+
+[![pylint](https://github.com/kamangir/bluer-options/actions/workflows/pylint.yml/badge.svg)](https://github.com/kamangir/bluer-options/actions/workflows/pylint.yml) [![pytest](https://github.com/kamangir/bluer-options/actions/workflows/pytest.yml/badge.svg)](https://github.com/kamangir/bluer-options/actions/workflows/pytest.yml) [![PyPI version](https://img.shields.io/pypi/v/bluer-options.svg)](https://pypi.org/project/bluer-options/) [![PyPI - Downloads](https://img.shields.io/pypi/dd/bluer-options)](https://pypistats.org/packages/bluer-options)

bluer_options-5.292.1/bluer_options/.bash/alias.sh

@@ -0,0 +1,54 @@
+#! /usr/bin/env bash
+
+alias @assert=bluer_ai_assert
+
+alias @badge=bluer_ai_badge
+
+alias @browse=bluer_ai_browse
+
+alias @cat=bluer_ai_cat
+
+alias @code=bluer_ai_code
+
+alias @env=bluer_ai_env
+
+alias @eval=bluer_ai_eval
+
+alias @help=bluer_ai_help
+
+alias @hr=bluer_ai_hr
+
+alias @list=bluer_ai_list
+
+alias @log::list=bluer_ai_log_list
+
+alias @not=bluer_ai_not
+
+alias @open=bluer_ai_open
+
+alias @option=bluer_ai_option
+alias @option::int=bluer_ai_option_int
+alias @option::choice=bluer_ai_option_choice
+
+alias @options=bluer_options
+
+alias @pause=bluer_ai_pause
+
+alias @pylint=bluer_ai_pylint
+
+alias @pytest=bluer_ai_pytest
+
+alias @repeat=bluer_ai_repeat
+
+alias @sleep=bluer_ai_sleep
+
+alias @test=bluer_ai_test
+
+alias @timestamp=bluer_ai_string_timestamp
+alias @@timestamp=bluer_ai_string_timestamp_short
+
+alias @today=bluer_ai_string_today
+
+alias @wait=bluer_ai_wait
+
+alias @watch=bluer_ai_watch

bluer_options-5.292.1/bluer_options/.bash/assert.sh

@@ -0,0 +1,67 @@
+#! /usr/bin/env bash
+
+function bluer_ai_assert() {
+    local value=$1
+    local expected_value=$2
+    local sign=${3:-yes}
+
+    local function_name="${FUNCNAME[1]}"
+
+    if [[ "$sign" == "empty" ]]; then
+        if [[ -z "$value" ]]; then
+            bluer_ai_log "✅ $function_name: $value is empty."
+            return
+        fi
+
+        bluer_ai_log_error "$function_name: non-empty value."
+        return 1
+    fi
+
+    if [[ "$sign" == "non-empty" ]]; then
+        if [[ ! -z "$value" ]]; then
+            bluer_ai_log "✅ $function_name: $value is non-empty."
+            return
+        fi
+
+        bluer_ai_log_error "$function_name: empty value."
+        return 1
+    fi
+
+    if [[ "$sign" == "yes" ]]; then
+        if [[ "$value" == "$expected_value" ]]; then
+            bluer_ai_log "✅ $function_name: $value == $expected_value."
+            return
+        fi
+
+        bluer_ai_log_error "$function_name: $value != $expected_value"
+        return 1
+    else
+        if [[ "$value" != "$expected_value" ]]; then
+            bluer_ai_log "✅ $function_name: $value != $expected_value."
+            return
+        fi
+
+        bluer_ai_log_error "$function_name: $value == $expected_value"
+        return 1
+    fi
+}
+
+function bluer_ai_assert_file_exists() {
+    local filename=$1
+
+    local function_name="${FUNCNAME[1]}"
+
+    if [[ -f "$filename" ]]; then
+        bluer_ai_log "✅ $function_name: $filename - file exists."
+        return 0
+    fi
+
+    bluer_ai_log_error "$function_name: $filename - file not found."
+    return 1
+}
+
+function bluer_ai_assert_list() {
+    bluer_ai_assert \
+        $(bluer_ai_list_sort "$1") \
+        $(bluer_ai_list_sort "$2")
+}

bluer_options-5.292.1/bluer_options/.bash/bluer_options.sh

@@ -0,0 +1,55 @@
+#! /usr/bin/env bash
+
+function bluer_options() {
+    local task=$1
+
+    bluer_ai_generic_task \
+        plugin=bluer_options,task=$task \
+        "${@:2}"
+}
+
+function bluer_options_action_git_before_push() {
+    [[ "$(bluer_ai_git get_branch)" != "main" ]] &&
+        return 0
+
+    bluer_options pypi build
+}
+
+python3 -m bluer_options version \
+    --show_icon 1
+
+function bluer_options_source_dependencies() {
+    local path=$1
+
+    source $path/options.sh
+    source $path/source.sh
+
+    source $path/assert.sh
+    source $path/bool.sh
+    source $path/browse.sh
+    source $path/code.sh
+    source $path/env.sh
+    source $path/eval.sh
+    source $path/generic_task.sh
+    source $path/help.sh
+    source $path/install.sh
+    source $path/list.sh
+    source $path/logging.sh
+    source $path/open.sh
+    source $path/pause.sh
+    source $path/plugins.sh
+    source $path/pylint.sh
+    source $path/pytest.sh
+    source $path/repeat.sh
+    source $path/seed.sh
+    source $path/sleep.sh
+    source $path/string.sh
+    source $path/terminal.sh
+    source $path/test.sh
+    source $path/wait.sh
+    source $path/watch.sh
+
+    source $path/alias.sh
+}
+
+bluer_options_source_dependencies $(dirname "$(realpath "${BASH_SOURCE[0]}")")

bluer_options-5.292.1/bluer_options/.bash/bool.sh

@@ -0,0 +1,9 @@
+#! /usr/bin/env bash
+
+function bluer_ai_not() {
+    if [ "$1" == 1 ] || [ "$1" == true ]; then
+        echo 0
+    else
+        echo 1
+    fi
+}

bluer_options-5.292.1/bluer_options/.bash/browse.sh

@@ -0,0 +1,22 @@
+#! /usr/bin/env bash
+
+function bluer_ai_browse() {
+    local url=$1
+
+    local description=$2
+    [[ ! -z "$description" ]] &&
+        bluer_ai_log "$description"
+
+    [[ -z "$url" ]] && return 0
+
+    bluer_ai_log "🔗 $url"
+    if [ "$abcli_is_mac" == true ]; then
+        open "$url"
+    elif [ "$abcli_is_ec2" == true ]; then
+        firefox "$url"
+    elif [ "$abcli_is_rpi" == true ]; then
+        DISPLAY=:0 chromium-browser -kiosk --no-sandbox "$url"
+    else
+        bluer_ai_log_warning "@browse: $url: skipped."
+    fi
+}

bluer_options-5.292.1/bluer_options/.bash/code.sh

@@ -0,0 +1,13 @@
+#! /usr/bin/env bash
+
+function bluer_ai_code() {
+    bluer_ai_log "editing $@"
+
+    if [[ "$abcli_is_mac" == true ]]; then
+        /Applications/Visual\ Studio\ Code.app/Contents/Resources/app/bin/code "$@"
+    elif [[ "$abcli_is_github_workflow" == true ]]; then
+        bluer_ai_log_warning "@code: $@: skipped."
+    else
+        nano "$@"
+    fi
+}