Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/0.0.111 #50

Merged
merged 15 commits into from
Nov 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"python.linting.flake8Enabled": true,
"python.linting.enabled": true
"python.linting.enabled": true,
"grammarly.selectors": [
{
"language": "markdown",
"scheme": "file"
}
]
}
253 changes: 196 additions & 57 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/concepts/tasks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
616 changes: 435 additions & 181 deletions docs/getting-started.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/development-to-deployment-low-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
44 changes: 44 additions & 0 deletions install.sh
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]" },
]
Expand Down
4 changes: 2 additions & 2 deletions src/zrb/builtin/base64.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
Expand All @@ -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
)
Expand Down