From 5c7f2914cda88dd4e32fa0004bfa234dbffe3f02 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Sat, 8 Feb 2020 20:47:13 +0100 Subject: [PATCH] :pencil2: Re-branding to match Home Assistant naming changes --- .github/settings.yml | 4 ++-- README.md | 39 +++++++++++++++++++++------------------ lib/addons.sh | 16 ++++++++-------- lib/api.sh | 6 +++--- lib/bashio | 4 ++-- lib/bashio.sh | 4 ++-- lib/cache.sh | 4 ++-- lib/color.sh | 4 ++-- lib/config.sh | 8 ++++---- lib/const.sh | 4 ++-- lib/debug.sh | 4 ++-- lib/discovery.sh | 4 ++-- lib/dns.sh | 6 +++--- lib/exit.sh | 4 ++-- lib/fs.sh | 4 ++-- lib/hardware.sh | 4 ++-- lib/host.sh | 4 ++-- lib/jq.sh | 4 ++-- lib/net.sh | 4 ++-- lib/pwned.sh | 4 ++-- lib/repositories.sh | 4 ++-- lib/services.sh | 4 ++-- lib/string.sh | 4 ++-- lib/supervisor.sh | 6 +++--- lib/var.sh | 4 ++-- 25 files changed, 80 insertions(+), 77 deletions(-) diff --git a/.github/settings.yml b/.github/settings.yml index 719e28b..7840418 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -1,8 +1,8 @@ --- repository: - description: "Bashio - Community Hass.io Add-on for Home Assistant" + description: "Bashio - Community Home Assistant Add-ons" homepage: https://addons.community - topics: bash, bash-library, hassio, hassio-addons, home-assistant, homeassistant + topics: bash, bash-library, addons, home-assistant, homeassistant private: false has_issues: true has_projects: false diff --git a/README.md b/README.md index e529da7..470060a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Community Hass.io Add-ons: Bashio +# Community Home Assistant Add-ons: Bashio [![GitHub Release][releases-shield]][releases] ![Project Stage][project-stage-shield] @@ -16,7 +16,7 @@ ## About -Bashio is an bash function library for use with Hass.io add-ons. +Bashio is an bash function library for use with Home Assistant add-ons. It contains a set of commonly used operations and can be used to be included in add-ons to reduce code duplication across add-ons and @@ -34,20 +34,22 @@ instead of other things. ## Installation -The library is installed in the Community Hass.io Add-ons base images and -the official Hassio base images by Home Assistant. +The library is installed in the Community Home Assistant Add-ons base images and +the official Home Assistant base images. Currently available base images: -- [Community Hassio Add-ons Alpine Base Image][base-alpine] -- [Community Hassio Add-ons Alpine Python Base Image][base-alpine-python] -- [Community Hassio Add-ons Ubuntu Base Image][base-ubuntu] -- [Official Hassio Alpine Base Image][hassio-base] -- [Official Hassio Alpine Python Base Image][hassio-base] -- [Official Hassio Ubuntu Base Image][hassio-base] -- [Official Hassio Raspbian Base Image][hassio-base] +- [Community Home Assistant Add-ons Alpine Base Image][base-alpine] +- [Community Home Assistant Add-ons Alpine Python Base Image][base-alpine-python] +- [Community Home Assistant Add-ons Debian Base Image][base-debian] +- [Community Home Assistant Add-ons Ubuntu Base Image][base-ubuntu] +- [Official Home Assistant Alpine Docker Base Image][home-assistant-base] +- [Official Home Assistant Alpine Python Docker Base Image][home-assistant-base] +- [Official Home Assistant Debian Docker Base Image][home-assistant-base] +- [Official Home Assistant Raspbian Docker Base Image][home-assistant-base] +- [Official Home Assistant Ubuntu Docker Base Image][home-assistant-base] -Using those images as the base for your Hass.io add-on, will provide this +Using those images as the base for your Home Assistant add-on, will provide this function library out of the box. Our base images are updated frequently and provides the minimal needed base image for a great add-on. @@ -85,7 +87,7 @@ bashio::log.info "${USERNAME}" ## Functions Bashio has more then 250+ functions available: communicating with -the Hass.io API, Have I Been Pwned, file system, logging, configuration handling +the Supervisor API, Have I Been Pwned, file system, logging, configuration handling and a lot more! The best way to get around, would be by looking at the different modules @@ -93,12 +95,12 @@ available in the [`lib`](lib) folder. Each module has its own file, and each function has been documented inside the code base. Further more, Bashio is used by the -[Community Hass.io Add-ons project][repository], those add-ons will be a great -resource of practical examples. +[Community Home Assistant Add-ons project][repository], those add-ons will be +a great resource of practical examples. ## Known issues and limitations -- Some parts of the Hass.io API are not implemented yet. +- Some parts of the Supervisor API are not implemented yet. ## Changelog & Releases @@ -120,7 +122,7 @@ Got questions? You have several options to get them answered: -- The [Community Hass.io Add-ons Discord chat server][discord] for add-on +- The [Community Home Assistant Add-ons Discord chat server][discord] for add-on support and feature requests. - You could also [open an issue here][issue] GitHub. @@ -167,6 +169,7 @@ SOFTWARE. [base-alpine-python]: https://github.com/hassio-addons/addon-base-python [base-alpine]: https://github.com/hassio-addons/addon-base +[base-debian]: https://github.com/hassio-addons/addon-debian-base [base-ubuntu]: https://github.com/hassio-addons/addon-ubuntu-base [commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/bashio.svg [commits]: https://github.com/hassio-addons/bashio/commits/master @@ -178,7 +181,7 @@ SOFTWARE. [github-sponsors]: https://github.com/sponsors/frenck [gitlabci-shield]: https://gitlab.com/hassio-addons/bashio/badges/master/pipeline.svg [gitlabci]: https://gitlab.com/hassio-addons/bashio/pipelines -[hassio-base]: https://github.com/home-assistant/hassio-base +[home-assistant-base]: https://github.com/home-assistant/docker-base [issue]: https://github.com/hassio-addons/bashio/issues [keepchangelog]: http://keepachangelog.com/en/1.0.0/ [license-shield]: https://img.shields.io/github/license/hassio-addons/bashio.svg diff --git a/lib/addons.sh b/lib/addons.sh index 79894d5..2d4d274 100644 --- a/lib/addons.sh +++ b/lib/addons.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. @@ -694,7 +694,7 @@ function bashio::addon.changelog() { } # ------------------------------------------------------------------------------ -# Returns whether or not this add-on can access the Hass.io API. +# Returns whether or not this add-on can access the Supervisor API. # # Arguments: # $1 Add-on slug (optional, default: self) @@ -706,7 +706,7 @@ function bashio::addon.hassio_api() { } # ------------------------------------------------------------------------------ -# Returns the Hass.io API role of this add-on. +# Returns the Supervisor API role of this add-on. # # Arguments: # $1 Add-on slug (optional, default: self) @@ -733,7 +733,7 @@ function bashio::addon.homeassistant_api() { } # ------------------------------------------------------------------------------ -# Returns whether or not this add-on can access the Hass.io Authentication API. +# Returns whether or not this add-on can access the Supervisor Auth API. # # Arguments: # $1 Add-on slug (optional, default: self) @@ -769,7 +769,7 @@ function bashio::addon.rating() { } # ------------------------------------------------------------------------------ -# Returns whether or not this add-on can use the STDIN on the Hass.io API. +# Returns whether or not this add-on can use the STDIN on the Supervisor API. # # Arguments: # $1 Add-on slug (optional, default: self) @@ -1154,7 +1154,7 @@ function bashio::require.protected() { bashio::log.fatal "Pleas enable it again!" bashio::log.fatal "" bashio::log.fatal "Steps:" - bashio::log.fatal " - Go to the Hass.io Panel." + bashio::log.fatal " - Go to the Supervisor Panel." bashio::log.fatal " - Click on this add-on." bashio::log.fatal " - Set the 'Protection mode' switch to on." bashio::log.fatal " - Restart the add-on." @@ -1181,7 +1181,7 @@ function bashio::require.unprotected() { bashio::log.fatal "is unable to access Docker." bashio::log.fatal bashio::log.fatal "Steps:" - bashio::log.fatal " - Go to the Hass.io Panel." + bashio::log.fatal " - Go to the Supervisor Panel." bashio::log.fatal " - Click on this add-on." bashio::log.fatal " - Set the 'Protection mode' switch to off." bashio::log.fatal " - Restart the add-on." diff --git a/lib/api.sh b/lib/api.sh index fb73498..4a2fe48 100644 --- a/lib/api.sh +++ b/lib/api.sh @@ -1,14 +1,14 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. # ============================================================================== # ------------------------------------------------------------------------------ -# Makes a call to the Hass.io API. +# Makes a call to the Supervisor API. # # Arguments: # $1 HTTP Method (GET/POST) diff --git a/lib/bashio b/lib/bashio index 28f94b7..bf73c9d 100755 --- a/lib/bashio +++ b/lib/bashio @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/bashio.sh b/lib/bashio.sh index a33af4f..a6e9afe 100644 --- a/lib/bashio.sh +++ b/lib/bashio.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/cache.sh b/lib/cache.sh index 631d848..f05f976 100644 --- a/lib/cache.sh +++ b/lib/cache.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/color.sh b/lib/color.sh index 3c4d391..d8508a3 100644 --- a/lib/color.sh +++ b/lib/color.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/config.sh b/lib/config.sh index 651092a..9e0dd00 100644 --- a/lib/config.sh +++ b/lib/config.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. @@ -580,7 +580,7 @@ function bashio::config.require.ssl() { bashio::log.fatal "'${certfile}' option does not exists." bashio::log.fatal bashio::log.fatal "Please ensure the certificate file exists and" - bashio::log.fatal "is placed in the Hass.io '/ssl/' directory." + bashio::log.fatal "is placed in the '/ssl/' directory." bashio::log.fatal bashio::log.fatal "In case you don't have SSL yet, consider getting" bashio::log.fatal "a SSL certificate or setting the '${key}' option" @@ -604,7 +604,7 @@ function bashio::config.require.ssl() { bashio::log.fatal "'${keyfile}' option does not exists." bashio::log.fatal bashio::log.fatal "Please ensure the certificate key file exists and" - bashio::log.fatal "is placed in the Hass.io '/ssl/' directory." + bashio::log.fatal "is placed in the '/ssl/' directory." bashio::log.fatal bashio::log.fatal "In case you don't have SSL yet, consider getting" bashio::log.fatal "a SSL certificate or setting the '${key}' option" diff --git a/lib/const.sh b/lib/const.sh index 0a32b6f..8eafe33 100644 --- a/lib/const.sh +++ b/lib/const.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/debug.sh b/lib/debug.sh index 30fe18c..f758248 100644 --- a/lib/debug.sh +++ b/lib/debug.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/discovery.sh b/lib/discovery.sh index 3373c22..ee30480 100644 --- a/lib/discovery.sh +++ b/lib/discovery.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/dns.sh b/lib/dns.sh index f0e4fa2..fa36e27 100644 --- a/lib/dns.sh +++ b/lib/dns.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. @@ -92,7 +92,7 @@ function bashio::dns() { } # ------------------------------------------------------------------------------ -# Returns the Hass.io DNS host. +# Returns the Home Assistant DNS host. # ------------------------------------------------------------------------------ function bashio::dns.host() { bashio::log.trace "${FUNCNAME[0]}" diff --git a/lib/exit.sh b/lib/exit.sh index f587388..a15ce27 100644 --- a/lib/exit.sh +++ b/lib/exit.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/fs.sh b/lib/fs.sh index ff8372f..05ca01f 100644 --- a/lib/fs.sh +++ b/lib/fs.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/hardware.sh b/lib/hardware.sh index 4a3d2a2..33a615e 100644 --- a/lib/hardware.sh +++ b/lib/hardware.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/host.sh b/lib/host.sh index 53545fc..794cffb 100644 --- a/lib/host.sh +++ b/lib/host.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/jq.sh b/lib/jq.sh index 0950e56..7244138 100644 --- a/lib/jq.sh +++ b/lib/jq.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/net.sh b/lib/net.sh index c3c820b..aa1d9bd 100644 --- a/lib/net.sh +++ b/lib/net.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/pwned.sh b/lib/pwned.sh index 669718a..3e195c0 100644 --- a/lib/pwned.sh +++ b/lib/pwned.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/repositories.sh b/lib/repositories.sh index 8d353fb..1567fb6 100644 --- a/lib/repositories.sh +++ b/lib/repositories.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/services.sh b/lib/services.sh index 1c3ae34..4811415 100644 --- a/lib/services.sh +++ b/lib/services.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/string.sh b/lib/string.sh index bf8b3c0..d1c0b3c 100644 --- a/lib/string.sh +++ b/lib/string.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. diff --git a/lib/supervisor.sh b/lib/supervisor.sh index c24050c..5b84188 100644 --- a/lib/supervisor.sh +++ b/lib/supervisor.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons. @@ -91,7 +91,7 @@ function bashio::supervisor() { } # ------------------------------------------------------------------------------ -# Returns the Hass.io supervisor version used. +# Returns the Home Assistant Supervisor version used. # ------------------------------------------------------------------------------ function bashio::supervisor.version() { bashio::log.trace "${FUNCNAME[0]}" diff --git a/lib/var.sh b/lib/var.sh index 0fa55cd..70a8f4a 100644 --- a/lib/var.sh +++ b/lib/var.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # ============================================================================== -# Community Hass.io Add-ons: Bashio -# Bashio is an bash function library for use with Hass.io add-ons. +# Community Home Assistant Add-ons: Bashio +# Bashio is an bash function library for use with Home Assistant add-ons. # # It contains a set of commonly used operations and can be used # to be included in add-on scripts to reduce code duplication across add-ons.