Release/0.0.111 (#50)

* update version * WIP: release 0.0.111 * update getting started * update docs * update getting started example * update README * update getting started * remove files * update README
state-alchemists · Nov 12, 2023 · 4436e23 · 4436e23
1 parent 024d9f5
commit 4436e23
Show file tree

Hide file tree

Showing 9 changed files with 690 additions and 247 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,10 @@
 {
     "python.linting.flake8Enabled": true,
-    "python.linting.enabled": true
+    "python.linting.enabled": true,
+    "grammarly.selectors": [
+        {
+            "language": "markdown",
+            "scheme": "file"
+        }
+    ]
 }
diff --git a/README.md b/README.md
diff --git a/docs/concepts/tasks/README.md b/docs/concepts/tasks/README.md
@@ -38,7 +38,7 @@ Task  CmdTask  ResourceMaker  FlowTask  BaseRemoteCmdTask  HttpChecker PortCheck
 
 Aside from the documentation, you can always dive down into [the source code](https://github.com/state-alchemists/zrb/tree/main/src/zrb/task) to see the detail implementation.
 
-> __Note:__ Never initiate `BaseTask` directly, use `Task` instead.
+> __📝 NOTE:__ Never initiate `BaseTask` directly, use `Task` instead.
 
 # Task Overview
 
@@ -116,7 +116,7 @@ As `start_jupyterlab` has `show_banner` as it's upstream, you can expect the `sh
 
 A task might also have multiple upstreams. In that case, the upstreams will be executed concurrently.
 
-> __Note:__ Only tasks registered to `runner` are directly accessible from the CLI.
+> __📝 NOTE:__ Only tasks registered to `runner` are directly accessible from the CLI.
 
 # Task Lifecycle
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/oops-i-did-it-again/not-registering-a-task-to-a-runner.md b/docs/oops-i-did-it-again/not-registering-a-task-to-a-runner.md
@@ -18,7 +18,7 @@ zrb hello
 
 If you want your task to be available through the CLI, you need to register it to Zrb's runner.
 
-> __NOTE:__ A task that is not registered to Zrb's runner will not be available through the CLI, but can still be used as upstreams/checkers.
+> __📝 NOTE:__ A task that is not registered to Zrb's runner will not be available through the CLI, but can still be used as upstreams/checkers.
 
 # Avoiding the Problem
 

diff --git a/docs/tutorials/development-to-deployment-low-code.md b/docs/tutorials/development-to-deployment-low-code.md
@@ -26,7 +26,7 @@ Before starting the demo, you need to make sure you have the following software
 - Zrb
 - Access to a Kubernetes cluster
 
-> __Note:__ Installing docker desktop will give you docker + docker compose extension, as well as local kubernetes cluster (if enabled).
+> __📝 NOTE:__ Installing docker desktop will give you docker + docker compose extension, as well as local kubernetes cluster (if enabled).
 
 Once everything is set, you can run the following commands on your terminal:
 
@@ -158,7 +158,7 @@ To run `myapp` as containers you can invoke:
 zrb project start-myapp-container --myapp-run-mode microservices
 ```
 
-> __Note:__ You can also run the container as a monolith if you want to. Just invoke `zrb project start-myapp-container --myapp-run-mode monolith`
+> __📝 NOTE:__ You can also run the container as a monolith if you want to. Just invoke `zrb project start-myapp-container --myapp-run-mode monolith`
 
 Now let's see how things look like by invoking:
 

diff --git a/install.sh b/install.sh
@@ -0,0 +1,44 @@
+set -e
+
+# Make sure pyenv is installed
+if [ ! -d "$HOME/.pyenv" ]
+then
+    echo "Installing Pyenv"
+    curl https://pyenv.run | bash
+
+    # Register .pyenv to .zshrc
+    if [ -f "$HOME/.zshrc" ]
+    then
+        echo "Registering Pyenv to .zshrc"
+        echo '' >> $HOME/.zshrc
+        echo 'export PYENV_ROOT="$HOME/.pyenv"' >> $HOME/.zshrc
+        echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> $HOME/.zshrc
+        echo 'eval "$(pyenv init -)"' >> $HOME/.zshrc
+    fi
+
+    # Register .pyenv to .bashrc
+    if [ -f "$HOME/.bashrc" ]
+    then
+        echo "Registering Pyenv to .bashrc"
+        echo '' >> $HOME/.bashrc
+        echo 'export PYENV_ROOT="$HOME/.pyenv"' >> $HOME/.bashrc
+        echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> $HOME/.bashrc
+        echo 'eval "$(pyenv init -)"' >> $HOME/.bashrc
+    fi
+
+    # Activate pyenv
+    echo "Activating pyenv"
+    export PYENV_ROOT="$HOME/.pyenv"
+    command -v pyenv >/dev/null || (export PATH="$PYENV_ROOT/bin:$PATH" && eval "$(pyenv init -)")
+
+    # Install python 3.10.0
+    echo "Installing python 3.10.0"
+    pyenv install 3.10.0
+
+    # Set global python to 3.10.0
+    echo "Set python 3.10.0 as global"
+    pyenv global 3.10.0
+fi
+
+echo "Installing Zrb"
+pip install zrb
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "zrb"
-version = "0.0.110"
+version = "0.0.111"
 authors = [
   { name="Go Frendi Gunawan", email="[email protected]" },
 ]

diff --git a/src/zrb/builtin/base64.py b/src/zrb/builtin/base64.py
@@ -26,7 +26,7 @@
     name='encode',
     group=base64_group,
     inputs=[text_input],
-    description='Encode base64 task',
+    description='Encode a text using base64 algorithm',
     retry=0,
     runner=runner
 )
@@ -40,7 +40,7 @@ async def encode(*args: str, **kwargs: Any):
     name='decode',
     group=base64_group,
     inputs=[text_input],
-    description='Decode base64 task',
+    description='Decode a base64 encoded text',
     retry=0,
     runner=runner
 )