zrb 0.0.107__tar.gz → 0.0.109__tar.gz

{zrb-0.0.107 → zrb-0.0.109}/.github/workflows/_zrb.yml

@@ -17,7 +17,7 @@ jobs:
   Run-command:
     runs-on: ubuntu-latest
     container:
-      image: stalchmst/zrb:0.0.106
+      image: stalchmst/zrb:0.0.108
     steps:
       - name: Check out repository code
         uses: actions/checkout@v3

{zrb-0.0.107 → zrb-0.0.109}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 0.0.107
+Version: 0.0.109
 Summary: Super framework for your super app
 Author-email: Go Frendi Gunawan <gofrendiasgard@gmail.com>
 Requires-Python: >=3.10.0
@@ -30,15 +30,17 @@ Provides-Extra: test
 
 # 🤖 Zrb (Read: Zaruba) : A Super Framework for Your Super App
 
-![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/zrb/android-chrome-192x192.png)
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
 
-[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md)
+[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Oops, I did it Again](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md) | [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
 
-Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) automation [tool](https://en.wikipedia.org/wiki/Programming_tool) and [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) platform. Once installed, you can automate day-to-day tasks, generate projects and applications, and even deploy your applications to Kubernetes with a few commands.
+Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) automation [tool](https://en.wikipedia.org/wiki/Programming_tool) and [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) platform. Once installed, Zrb will help you automate day-to-day tasks, generate projects and applications, and even deploy your applications to Kubernetes with a few commands.
 
 To use Zrb, you need to be familiar with CLI.
 
-## Zrb as a low-code framework
+Zrb task definitions are written in [Python](https://www.python.org/), and we have a [very good reason](https://github.com/state-alchemists/zrb/blob/main/docs/faq/why-python.md) behind the decision.
+
+## Zrb is A Low-Code Framework
 
 Let's see how you can build and run a [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) application.
 
@@ -67,9 +69,9 @@ zrb project start-fastapp --fastapp-run-mode "monolith"
 
 You will be able to access the application by pointing your browser to [http://localhost:3000](http://localhost:3000)
 
-![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/fastapp.png)
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/fastapp.png)
 
-Furthermore, you can also run the same application as `microservices`, run the application as `docker containers`, and even doing some deployments into your `kubernetes cluster`.
+Furthermore, you can run the same application as `microservices`, run the application as `docker containers`, and even do some deployments into your `kubernetes cluster`.
 
 
 ```bash
@@ -88,9 +90,9 @@ zrb project deploy-fastapp --fastapp-deploy-mode "microservices"
 You can visit [our tutorials](https://github.com/state-alchemists/zrb/blob/main/docs/tutorials/README.md) to see more cool tricks.
 
 
-## Zrb as a task-automation framework
+## Zrb is A Task-Automation Tool
 
-Aside from the builtin capabilities, Zrb also allows you to define your automation commands in Python. To do so, you need to create/modify a file named `zrb_init.py`.
+Aside from the built-in capabilities, Zrb also allows you to define your automation commands in Python. To do so, you must create/modify a file named `zrb_init.py`.
 
 ```python
 # filename: zrb_init.py
@@ -131,7 +133,7 @@ To learn more about this, you can visit [our getting started guide](https://gith
 
 # 🫰 Installation
 
-## ⚙️ In local machine
+## ⚙️ In Local Machine
 
 Installing Zrb in your system is as easy as typing the following command in your terminal:
 
@@ -139,11 +141,11 @@ Installing Zrb in your system is as easy as typing the following command in your
 pip install zrb
 ```
 
-Just like any other Python package, you can also install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). This will allow you to have many versions of Zrb on the same computer.
+Like any other Python package, you can install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). This will allow you to have many versions of Zrb on the same computer.
 
 > ⚠️ If the command doesn't work, you probably don't have Pip/Python on your computer. See `Main prerequisites` subsection to install them.
 
-## 🐋 With docker
+## 🐋 With Docker
 
 If you prefer to work with Docker, you can create a file named `docker-compose.yml`
 
@@ -182,7 +184,7 @@ You will be able to access Zrb by using docker exec:
 docker exec -it zrb zsh
 ```
 
-# ✅ Main prerequisites
+# ✅ Main Prerequisites
 
 Since Zrb is written in Python, you need to install a few things before installing Zrb:
 
@@ -207,11 +209,11 @@ ln -s venv/bin/python3 /usr/local/bin/python
 
 If you prefer Python distribution like [conda](https://docs.conda.io/en/latest/), that might work as well.
 
-# ✔️ Other prerequisites
+# ✔️ Other Prerequisites
 
 If you want to generate applications using Zrb and run them on your computer, you will also need:
 
-- 🐸 `Node.Js` and `Npm`. 
+- 🐸 `Node.Js` and `Npm`.
     - You need Node.Js to modify/transpile frontend code into static files.
     - You can visit the [Node.Js website](https://nodejs.org/en) for installation instructions.
 - 🐋 `Docker` and `Docker-compose` plugin.
@@ -226,9 +228,9 @@ If you want to generate applications using Zrb and run them on your computer, yo
 - 🦆 `Pulumi`
     - You need Pulumi to deploy your applications
 
-# 🏁 Getting started
+# 🏁 Getting Started
 
-We have a nice [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) to help you cover the basics. Make sure to check it out😉.
+We have an excellent [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) to help you cover the basics. Make sure to check it out😉.
 
 # 📖 Documentation
 
@@ -238,11 +240,11 @@ You can visit [Zrb documentation](https://github.com/state-alchemists/zrb/blob/m
 
 Help Red Skull to click the donation button:
 
-[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/donator.png)](https://stalchmst.com/donation)
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
 
-# 🎉 Fun fact
+# 🎉 Fun Fact
 
 > Madou Ring Zaruba (魔導輪ザルバ, Madōrin Zaruba) is a Madougu which supports bearers of the Garo Armor. [(Garo Wiki | Fandom)](https://garo.fandom.com/wiki/Zaruba)
 
-![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/madou-ring-zaruba.jpg)
+![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/madou-ring-zaruba.jpg)
 

{zrb-0.0.107 → zrb-0.0.109}/README.md

@@ -1,14 +1,16 @@
 # 🤖 Zrb (Read: Zaruba) : A Super Framework for Your Super App
 
-![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/zrb/android-chrome-192x192.png)
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/zrb/android-chrome-192x192.png)
 
-[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md)
+[📖 Documentation](https://github.com/state-alchemists/zrb/blob/main/docs/README.md) | [🏁 Getting Started](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) | [💃 Oops, I did it Again](https://github.com/state-alchemists/zrb/blob/main/docs/oops-i-did-it-again/README.md) | [❓ FAQ](https://github.com/state-alchemists/zrb/blob/main/docs/faq/README.md)
 
-Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) automation [tool](https://en.wikipedia.org/wiki/Programming_tool) and [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) platform. Once installed, you can automate day-to-day tasks, generate projects and applications, and even deploy your applications to Kubernetes with a few commands.
+Zrb is a [CLI-based](https://en.wikipedia.org/wiki/Command-line_interface) automation [tool](https://en.wikipedia.org/wiki/Programming_tool) and [low-code](https://en.wikipedia.org/wiki/Low-code_development_platform) platform. Once installed, Zrb will help you automate day-to-day tasks, generate projects and applications, and even deploy your applications to Kubernetes with a few commands.
 
 To use Zrb, you need to be familiar with CLI.
 
-## Zrb as a low-code framework
+Zrb task definitions are written in [Python](https://www.python.org/), and we have a [very good reason](https://github.com/state-alchemists/zrb/blob/main/docs/faq/why-python.md) behind the decision.
+
+## Zrb is A Low-Code Framework
 
 Let's see how you can build and run a [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) application.
 
@@ -37,9 +39,9 @@ zrb project start-fastapp --fastapp-run-mode "monolith"
 
 You will be able to access the application by pointing your browser to [http://localhost:3000](http://localhost:3000)
 
-![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/fastapp.png)
+![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/fastapp.png)
 
-Furthermore, you can also run the same application as `microservices`, run the application as `docker containers`, and even doing some deployments into your `kubernetes cluster`.
+Furthermore, you can run the same application as `microservices`, run the application as `docker containers`, and even do some deployments into your `kubernetes cluster`.
 
 
 ```bash
@@ -58,9 +60,9 @@ zrb project deploy-fastapp --fastapp-deploy-mode "microservices"
 You can visit [our tutorials](https://github.com/state-alchemists/zrb/blob/main/docs/tutorials/README.md) to see more cool tricks.
 
 
-## Zrb as a task-automation framework
+## Zrb is A Task-Automation Tool
 
-Aside from the builtin capabilities, Zrb also allows you to define your automation commands in Python. To do so, you need to create/modify a file named `zrb_init.py`.
+Aside from the built-in capabilities, Zrb also allows you to define your automation commands in Python. To do so, you must create/modify a file named `zrb_init.py`.
 
 ```python
 # filename: zrb_init.py
@@ -101,7 +103,7 @@ To learn more about this, you can visit [our getting started guide](https://gith
 
 # 🫰 Installation
 
-## ⚙️ In local machine
+## ⚙️ In Local Machine
 
 Installing Zrb in your system is as easy as typing the following command in your terminal:
 
@@ -109,11 +111,11 @@ Installing Zrb in your system is as easy as typing the following command in your
 pip install zrb
 ```
 
-Just like any other Python package, you can also install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). This will allow you to have many versions of Zrb on the same computer.
+Like any other Python package, you can install Zrb in your [virtual environment](https://docs.python.org/3/library/venv.html). This will allow you to have many versions of Zrb on the same computer.
 
 > ⚠️ If the command doesn't work, you probably don't have Pip/Python on your computer. See `Main prerequisites` subsection to install them.
 
-## 🐋 With docker
+## 🐋 With Docker
 
 If you prefer to work with Docker, you can create a file named `docker-compose.yml`
 
@@ -152,7 +154,7 @@ You will be able to access Zrb by using docker exec:
 docker exec -it zrb zsh
 ```
 
-# ✅ Main prerequisites
+# ✅ Main Prerequisites
 
 Since Zrb is written in Python, you need to install a few things before installing Zrb:
 
@@ -177,11 +179,11 @@ ln -s venv/bin/python3 /usr/local/bin/python
 
 If you prefer Python distribution like [conda](https://docs.conda.io/en/latest/), that might work as well.
 
-# ✔️ Other prerequisites
+# ✔️ Other Prerequisites
 
 If you want to generate applications using Zrb and run them on your computer, you will also need:
 
-- 🐸 `Node.Js` and `Npm`. 
+- 🐸 `Node.Js` and `Npm`.
     - You need Node.Js to modify/transpile frontend code into static files.
     - You can visit the [Node.Js website](https://nodejs.org/en) for installation instructions.
 - 🐋 `Docker` and `Docker-compose` plugin.
@@ -196,9 +198,9 @@ If you want to generate applications using Zrb and run them on your computer, yo
 - 🦆 `Pulumi`
     - You need Pulumi to deploy your applications
 
-# 🏁 Getting started
+# 🏁 Getting Started
 
-We have a nice [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) to help you cover the basics. Make sure to check it out😉.
+We have an excellent [getting started guide](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md) to help you cover the basics. Make sure to check it out😉.
 
 # 📖 Documentation
 
@@ -208,10 +210,10 @@ You can visit [Zrb documentation](https://github.com/state-alchemists/zrb/blob/m
 
 Help Red Skull to click the donation button:
 
-[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/donator.png)](https://stalchmst.com/donation)
+[![](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/donator.png)](https://stalchmst.com/donation)
 
-# 🎉 Fun fact
+# 🎉 Fun Fact
 
 > Madou Ring Zaruba (魔導輪ザルバ, Madōrin Zaruba) is a Madougu which supports bearers of the Garo Armor. [(Garo Wiki | Fandom)](https://garo.fandom.com/wiki/Zaruba)
 
-![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/images/madou-ring-zaruba.jpg)
+![Madou Ring Zaruba on Kouga's Hand](https://raw.githubusercontent.com/state-alchemists/zrb/main/_images/madou-ring-zaruba.jpg)

{zrb-0.0.107 → zrb-0.0.109}/docs/README.md

@@ -5,6 +5,7 @@
 - [Configurations](configurations.md)
 - [Tutorials](tutorials/README.md)
 - [Troubleshooting](troubleshooting/README.md)
-- [For contributors](for-contributors.md)
-- [For maintainers](for-maintainers.md)
-- [FAQ](faq.md)
+- [Oops, I Did it Again: The Most Common Mistakes When Working with Zrb](oops-i-did-it-again/README.md)
+- [Contributor Guide](contributor-guide.md)
+- [Maintainer Guide](maintainer-guide.md)
+- [FAQ](faq/README.md)

{zrb-0.0.107 → zrb-0.0.109}/docs/concepts/tasks/README.md

@@ -3,14 +3,16 @@
 
 # Type of Tasks
 
-There are many task types in Zrb. Every task has their own specific use-cases:
+There are many task types in Zrb. Every task has its own specific use cases:
 
 
 - [CmdTask](cmd-task.md): Run a CLI command
 - [Task (python task)](python-task.md): Run a Python function
 - [DockerComposeTask](docker-compose-task.md): Run a Docker compose Command
-- [Resource Maker](resource-maker.md): Generate artifacts/resources based on templates
+- [ResourceMaker](resource-maker.md): Generate artifacts/resources based on templates
 - [FlowTask](flow-task.md): Put `CmdTask` and `python task` into single flow.
+- [RemoteCmdTask](remote-cmd-task.md)
+- [RsyncTask](remote-cmd-task.md)
 - [Checkers (HttpChecker, PortChecker, and PathChecker)](checkers.md): Check parent task's readiness.
 
 As every task are extended from `BaseTask`, you will see that most of them share some common parameters.
@@ -38,7 +40,7 @@ Aside from the documentation, you can always dive down into [the source code](ht
 
 > __Note:__ Never initiate `BaseTask` directly, use `Task` instead.
 
-# Task overview
+# Task Overview
 
 Tasks are building blocks of your automation.
 
@@ -143,11 +145,11 @@ Triggered         ┌─────────► Ready ◄──┐
 - `Retry`: The task has been failed and will be re-started.
 - `Ready`: The task is ready.
 
-# Common task parameters
+# Common Task Parameters
 
 Zrb tasks share some common parameters like `name`, `icon`, `color`, `description`, etc.
 
-Some parameters are required, while some others are optionals. Please refer to [each specific task documentation](#type-of-tasks) for more complete list of parameters.
+Some parameters are required, while some others are optional. Please refer to [each specific task documentation](#type-of-tasks) for a more complete list of parameters.
 
 ## `name`
 
@@ -390,7 +392,7 @@ Boolean, whether return upstreams result instead of current task result or not.
 ## `on_failed`
 
 
-# Common task methods
+# Common Task Methods
 
 Every task share some common methods like `run`, `check`, and `to_function`.
 

{zrb-0.0.107 → zrb-0.0.109}/docs/concepts/tasks/cmd-task.md

@@ -69,7 +69,7 @@ You can then run the task by invoking:
 zrb say-hello --name=John
 ```
 
-# CmdTask parameters
+# CmdTask Parameters
 
 Every [task parameters](./task.md#common-task-parameters) are applicable here. Additionally, a `CmdTask` has it's own specific parameters.
 

{zrb-0.0.107 → zrb-0.0.109}/docs/concepts/tasks/docker-compose-task.md

@@ -49,7 +49,7 @@ zrb run-container
 
 Under the hood, Zrb will read your `compose_file` populate it with some additional configuration, and create a runtime compose file `._<compose-file>-<task-name>.runtime.yml`. Zrb will use the run the runtime compose file to run your `compose_cmd` (i.e., `docker compose -f <compose-file>-<task-name>.runtime.yml <compose-cmd>`)
 
-# DockerComposeTask parameters
+# DockerComposeTask Parameters
 
 Every [task parameters](./task.md#common-task-parameters) are applicable here. Additionally, a `DockerComposeTask` has it's own specific parameters.
 
@@ -159,7 +159,7 @@ runner.register(start_container)
 ## `preexec_fn`
 
 
-# DockerComposeTask methods
+# DockerComposeTask Methods
 
 Please refer to [common task methods](./README.md#common-task-methods).
 

{zrb-0.0.107 → zrb-0.0.109}/docs/concepts/tasks/python-task.md

@@ -75,7 +75,7 @@ zrb say-hello --name=John
 
 You can also use `async` function if you think you need to.
 
-# Task parameters
+# Task Parameters
 
 Every [common task parameters](./README.md#common-task-parameters) are applicable here. Additionally, a `Task` has some specific parameters.
 
@@ -155,7 +155,7 @@ Runner this task registered to.
 - __Possible values:__ `runner` or `None`
 - __Default value:__ `runner`
 
-# Task methods
+# Task Methods
 
 Please refer to [common task methods](./README.md#common-task-methods).
 

zrb-0.0.109/docs/concepts/tasks/remote-cmd-task.md

@@ -0,0 +1,30 @@
+🔖 [Table of Contents](../../README.md) / [Concepts](../README.md) / [Tasks](README.md)
+
+# RemoteCmdTask
+
+```python
+from zrb import (
+    runner, CmdTask, RemoteCmdTask, RemoteConfig, PasswordInput
+)
+
+install_curl = RemoteCmdTask(
+    name='install-curl',
+    inputs=[
+        PasswordInput(name='passsword')
+    ],
+    remote_configs=[
+        RemoteConfig(
+            host='192.168.1.10,
+            user='ubuntu,
+            password='{{input.password}}'
+        )
+    ],
+    cmd=[
+        'sudo apt update',
+        'sudo apt install curl --y'
+    ]
+)
+runner.register(install_curl)
+```
+
+🔖 [Table of Contents](../../README.md) / [Concepts](../README.md) / [Tasks](README.md)

{zrb-0.0.107 → zrb-0.0.109}/docs/concepts/tasks/resource-maker.md

@@ -59,7 +59,7 @@ runner.register(add_mit_license)
 Note that your template folder might contains a very complex structure. For example, you can make your application boiler plate into a template.
 
 
-# ResourceMaker parameters
+# ResourceMaker Parameters
 
 Every [task parameters](./task.md#common-task-parameters) are applicable here. Additionally, a `ResourceMaker` has it's own specific parameters.
 

zrb-0.0.109/docs/concepts/tasks/rsync-task.md

@@ -0,0 +1,53 @@
+🔖 [Table of Contents](../../README.md) / [Concepts](../README.md) / [Tasks](README.md)
+
+# RSyncTask
+
+```python
+from zrb import (
+    runner, CmdTask, RSyncTask, RemoteConfig, PasswordInput, StrInput
+)
+
+upload = RSyncTask(
+    name='upload',
+    inputs=[
+        PasswordInput(name='passsword'),
+        StrInput(name='src'),
+        StrInput(name='dst'),
+    ],
+    remote_configs=[
+        RemoteConfig(
+            host='192.168.1.10,
+            user='ubuntu,
+            password='{{input.password}}'
+        )
+    ],
+    is_remote_src=False,
+    is_remote_dst=True
+    src='{{input.src}}',
+    dst='{{input.dst}}',
+)
+runner.register(upload)
+
+download = RSyncTask(
+    name='download',
+    inputs=[
+        PasswordInput(name='passsword'),
+        StrInput(name='src'),
+        StrInput(name='dst'),
+    ],
+    remote_configs=[
+        RemoteConfig(
+            host='192.168.1.10,
+            user='ubuntu,
+            password='{{input.password}}'
+        )
+    ],
+    is_remote_src=True,
+    is_remote_dst=False
+    src='{{input.src}}',
+    dst='{{input.dst}}',
+)
+runner.register(download)
+```
+
+🔖 [Table of Contents](../../README.md) / [Concepts](../README.md) / [Tasks](README.md)

zrb-0.0.107/docs/for-contributors.md → zrb-0.0.109/docs/contributor-guide.md

@@ -1,6 +1,6 @@
 🔖 [Table of Contents](README.md)
 
-# For contributors
+# Contributor Guide
 
 
 As contributors, there are some things you can do:

zrb-0.0.109/docs/faq/README.md

@@ -0,0 +1,9 @@
+🔖 [Table of Contents](../README.md)
+
+# FAQ
+
+- [Why Python](why-python.md)
+- [Does Zrb has A Scheduler](does-zrb-has-a-scheduler.md)
+- [How to get data from other tasks](how-to-get-data-from-other-tasks.md)
+
+🔖 [Table of Contents](../README.md)

zrb-0.0.109/docs/faq/does-zrb-has-a-scheduler.md

@@ -0,0 +1,20 @@
+🔖 [Table of Contents](../README.md) / [FAQ](README.md)
+
+# Do Zrb has a Scheduler?
+
+No. Zrb focus is to help you run complicated tasks in a single run. You will need third party alternatives to make your tasks run by schedule.
+
+# Why No Scheduler?
+
+Implementing a Scheduler seems to be easy at the first glance.
+
+However, there are a few reasons why we don't build our own internal scheduler:
+
+- There are a lot of battle-proven tools and strategy you can already use.
+- Maintaining internal scheduler might distract us from the main goal.
+
+# What Can I Do to Make a Scheduled Task?
+
+Don't worry, there are some [tricks](../tutorials/run-task-by-schedule.md) you can use. For example you can use infinite loop, Cronjob, or even orchestrator like Airflow.
+
+🔖 [Table of Contents](../README.md) / [FAQ](README.md)

zrb-0.0.109/docs/faq/how-to-get-data-from-other-tasks.md

@@ -0,0 +1,11 @@
+🔖 [Table of Contents](../README.md) / [FAQ](README.md)
+
+# How to Get Data from Other Tasks?
+
+Tasks are usually be isolated from each other.
+
+But it some cases, sharing data among tasks can be quite handy. Zrb doesn't support this mechanism out of the box, but you can make use `_ZRB_EXECUTION_ID` to achieve what you want.
+
+See [this tutorial](../tutorials/getting-data-from-other-tasks.md) for more information.
+
+🔖 [Table of Contents](../README.md) / [FAQ](README.md)

zrb-0.0.109/docs/faq/why-python.md

@@ -0,0 +1,136 @@
+🔖 [Table of Contents](../README.md) / [FAQ](README.md)
+
+# Why Python?
+
+Python is a general multi-purpose language. It support a lot of pogramming paradigms like OOP/FP, or procedural. Writing a configuration in Python let you do a lot of things like control structure, etc.
+
+Python has been around since the 90's, and it was battle tested everywhere. Many people already familiar with the language. Even if you are new to the language, learning Python will be highly rewarding.
+
+Nevertheless, there are a lot of tools out there that don't use Python.
+
+So, we can extend the question: Why Python? Why not YAML/HCL/anything else?
+
+# Why not YAML?
+
+YAML format is widely used because of it's readability and simplicity. Many tools like [Ansible](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_intro.html) or [Docker Compose](https://docs.docker.com/compose/) use YAML files for their configuration.
+
+Using YAML for simple configuration can be a good idea.
+
+However, for more complex scenario (like when you need to do looping or branching), using YAML is quite challenging. You need to overcome this with some tricks:
+
+- Generating the YAML configuration somewhere else
+- Using templating language like Jinja or Go template
+- Implementing branch/loop structure in your YAML parser configuration
+
+Compared to this, Python already has built-in control structure.
+
+Moreover, you can define your Python configuration declaratively, almost like YAML.
+
+Let's see how Ansible playbook and Zrb config might like similar to each other:
+
+## Ansible Playbook
+
+First of all, you need to define your virtual machines
+
+```ini
+# file: vm_inventory.ini
+[my_vms]
+192.168.1.100 ansible_ssh_user=ubuntu
+192.168.1.101 ansible_ssh_user=ubuntu
+192.168.1.102 ansible_ssh_user=ubuntu
+```
+
+Then you create a playbook to define what you want to do with the virtual machines
+
+```yaml
+# file: install_curl.yml
+---
+- name: Install curl on VMs
+  hosts: my_vms
+  become: true
+  tasks:
+    - name: Update package cache
+      apt:
+        update_cache: yes
+
+    - name: Install curl
+      apt:
+        name: curl
+        state: present
+```
+
+Finally, you run the playbook agains the virtual machines:
+
+```bash
+ansible-playbook -i vm_inventory.ini install_curl.yml
+```
+
+## Zrb Task Definition
+
+You can define something similar with Zrb:
+
+```python
+# file: zrb_init.py
+from zrb import (
+    runner, CmdTask, RemoteCmdTask, RemoteConfig, PasswordInput
+)
+
+remote_configs = [
+    RemoteConfig(
+        host=f'192.168.1.{sub_ip}',
+        user='ubuntu'
+    ) for sub_ip in range(100, 103)
+]
+
+update_package_cache = RemoteCmdTask(
+    name='update-package-cache',
+    remote_configs=remote_configs,
+    cmd='sudo apt update'
+)
+
+install_curl = RemoteCmdTask(
+    name='install-curl',
+    remote_configs=remote_configs,
+    upstreams=[update_package_cache],
+    cmd='sudo apt install curl --y'
+)
+runner.register(install_curl)
+```
+
+Then you can run the the task by invoking:
+
+```bash
+zrb install-curl
+```
+
+## Comparing Ansible Playbook and Zrb Task Definition
+
+If you are not familiar with Python, Ansible Playbook will makes more sense for you. Ansible task definition is carefully crafted to cover most use cases.
+
+The trickiest part when you work with Ansible or any YAML based configuration is you need to understand the tool specification. Docker compose for example, has a very different configuration from ansible eventough both of them are using YAML.
+
+On the other hand, Python is just Python. You can use list comprehension, loop, branch, or anything you already know. The syntax highlighting, hint, and auto completion are commonly provided in your favorite tools.
+
+Even if you are new to Python, Zrb Task Definition is not very difficult to grasp. You can follow the [getting started guide](../getting-started.md) and tag along.
+
+
+# Why not Anything Else?
+
+There are a few of considerations.
+
+- Python is interpreted.
+
+  Other language like go or rust might give you a better performance, but the iteration is generally slower. You need to compile them into machine code in order to make it works.
+
+  Zrb is an automation tool. It helps developers doing their job. It doesn't serve any service to the end user. Thus, we can sacrifice the execution speed a little bit. No one will complain if your deployment is late for 0.5 seconds.
+
+- Python is popular.
+
+  If you are using macOS, there is a high chance you already have Python installed in your computer. Even if you are using Linux/Windows, installing Python is usually quite easy.
+
+- We want to focus on the features.
+
+  Building our own parser can be fun and challenging, but it doesn't bring any value to the user. We want to build Zrb on top of something battle proven, something you are already familiar with, something you can hack on without learning the whole new concept and specs.
+
+
+🔖 [Table of Contents](../README.md) / [FAQ](README.md)