zrb 0.10.0__py3-none-any.whl → 0.11.2__py3-none-any.whl

zrb/builtin/project/add/task/docker_compose/_input.py

@@ -0,0 +1,18 @@
+from zrb.task_input.int_input import IntInput
+from zrb.task_input.str_input import StrInput
+
+http_port_input = IntInput(
+    name="http-port",
+    shortcut="p",
+    description="HTTP port",
+    prompt="HTTP port",
+    default=8080,
+)
+
+compose_command_input = StrInput(
+    name="compose-command",
+    shortcut="c",
+    description="Compose command",
+    prompt="Compose command",
+    default="up",
+)

zrb/builtin/project/add/task/docker_compose/add.py

@@ -0,0 +1,81 @@
+import os
+
+from zrb.builtin.project._helper import (
+    create_register_module,
+    validate_existing_project_dir,
+    validate_inexisting_automation,
+)
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.task._group import project_add_task_group
+from zrb.builtin.project.add.task._input import task_name_input
+from zrb.builtin.project.add.task.docker_compose._input import (
+    compose_command_input,
+    http_port_input,
+)
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task.resource_maker import ResourceMaker
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+@python_task(
+    name="validate",
+    inputs=[
+        project_dir_input,
+        task_name_input,
+    ],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    task_name = kwargs.get("task_name")
+    validate_inexisting_automation(project_dir, task_name)
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        task_name_input,
+        compose_command_input,
+        http_port_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbTaskName": "{{input.task_name}}",
+        "zrbHttpPort": "{{input.http_port}}",
+        "zrbComposeCommand": "{{input.compose_command}}",
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+register_module = create_register_module(
+    module_path="_automate.{{util.to_snake_case(input.task_name)}}",
+    alias="_automate_{{util.to_snake_case(input.task_name)}}",
+    inputs=[task_name_input],
+    upstreams=[copy_resource],
+)
+
+
+@python_task(
+    name="docker-compose",
+    group=project_add_task_group,
+    inputs=[
+        project_dir_input,
+        task_name_input,
+        compose_command_input,
+        http_port_input,
+    ],
+    upstreams=[register_module],
+    runner=runner,
+)
+async def add_docker_compose_task(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")

zrb/builtin/project/add/task/docker_compose/template/_automate/snake_zrb_task_name.py

@@ -0,0 +1,30 @@
+import os
+
+from zrb import DockerComposeTask, Env, EnvFile, HTTPChecker, runner
+from zrb.builtin import project_group
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_PROJECT_DIR = os.path.abspath(os.path.join(_CURRENT_DIR, ".."))
+_RESOURCE_DIR = os.path.join(_PROJECT_DIR, "src", "kebab-zrb-task-name")
+
+snake_zrb_task_name = DockerComposeTask(
+    name="kebab-zrb-task-name",
+    description="human readable zrb task name",
+    group=project_group,
+    cwd=_RESOURCE_DIR,
+    compose_cmd="zrbComposeCommand",
+    compose_env_prefix="ZRB_ENV_PREFIX",
+    env_files=[
+        EnvFile(
+            path=os.path.join(_RESOURCE_DIR, "docker-compose.env"),
+            prefix="ZRB_ENV_PREFIX",
+        )
+    ],
+    envs=[
+        Env(
+            name="HOST_PORT", os_name="ZRB_ENV_PREFIX_HOST_PORT", default="zrbHttpPort"
+        ),
+    ],
+    checkers=[HTTPChecker(name="check-kebab-zrb-task-name", port="{{env.HOST_PORT}}")],
+)
+runner.register(snake_zrb_task_name)

zrb/builtin/project/add/task/docker_compose/template/src/kebab-zrb-task-name/image/main.py

@@ -0,0 +1,24 @@
+import os
+
+MESSAGE = os.getenv("APP_MESSAGE", "Hello, world!")
+PORT = int(os.getenv("APP_PORT", "8000"))
+
+
+async def app(scope, receive, send):
+    assert scope["type"] == "http"
+
+    await send(
+        {
+            "type": "http.response.start",
+            "status": 200,
+            "headers": [
+                [b"content-type", b"text/plain"],
+            ],
+        }
+    )
+    await send(
+        {
+            "type": "http.response.body",
+            "body": bytes(MESSAGE, "utf-8"),
+        }
+    )

zrb/builtin/project/add/task/python/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.task.python.add import add_python_task
+
+assert add_python_task

zrb/builtin/project/add/task/python/add.py

@@ -0,0 +1,67 @@
+import os
+
+from zrb.builtin.project._helper import (
+    create_register_module,
+    validate_existing_project_dir,
+    validate_inexisting_automation,
+)
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.task._group import project_add_task_group
+from zrb.builtin.project.add.task._input import task_name_input
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task.resource_maker import ResourceMaker
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+@python_task(
+    name="validate",
+    inputs=[
+        project_dir_input,
+        task_name_input,
+    ],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    task_name = kwargs.get("task_name")
+    validate_inexisting_automation(project_dir, task_name)
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        task_name_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbTaskName": "{{input.task_name}}",
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+register_module = create_register_module(
+    module_path="_automate.{{util.to_snake_case(input.task_name)}}",
+    alias="_automate_{{util.to_snake_case(input.task_name)}}",
+    inputs=[task_name_input],
+    upstreams=[copy_resource],
+)
+
+
+@python_task(
+    name="python",
+    group=project_add_task_group,
+    upstreams=[register_module],
+    runner=runner,
+)
+async def add_python_task(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")

zrb/builtin/project/add/task/python/template/_automate/snake_zrb_task_name.py

@@ -0,0 +1,19 @@
+from typing import Any, Mapping
+
+from zrb import Task, python_task, runner
+from zrb.builtin import project_group
+
+
+@python_task(
+    name="kebab-zrb-task-name",
+    description="human readable zrb task name",
+    group=project_group,
+    runner=runner,
+)
+async def snake_zrb_task_name(*args: Any, **kwargs: Any) -> Any:
+    task: Task = kwargs.get("_task")
+    env_map: Mapping[str, str] = task.get_env_map()
+    input_map: Mapping[str, str] = task.get_input_map()
+    task.print_out(f"Env map: {env_map}")
+    task.print_out(f"Input map: {input_map}")
+    return "ok"

zrb/builtin/project/create/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.create.create import create_project
+
+assert create_project

zrb/builtin/project/create/_helper.py

@@ -0,0 +1,15 @@
+import os
+
+from zrb.helper.typing import Mapping
+from zrb.task.resource_maker import ResourceMaker
+
+
+def copy_resource_replacement_mutator(
+    task: ResourceMaker, replacements: Mapping[str, str]
+) -> Mapping[str, str]:
+    replacements["zrbBaseProjectDir"] = os.path.basename(
+        replacements.get("zrbProjectDir", "")
+    )
+    if replacements.get("zrbProjectName", "") == "":
+        replacements["zrbProjectName"] = replacements.get("zrbBaseProjectDir", "")
+    return replacements

zrb/builtin/project/create/_input.py

@@ -0,0 +1,34 @@
+import os
+
+from zrb.task_input.str_input import StrInput
+
+SYSTEM_USER = os.getenv("USER", "incognito")
+
+project_name_input = StrInput(
+    name="project-name",
+    shortcut="n",
+    description="Project name",
+    prompt="Project name (can be empty)",
+    default="",
+)
+
+project_author_name_input = StrInput(
+    name="project-author-name",
+    prompt="Project author name",
+    description="Project author name",
+    default=SYSTEM_USER,
+)
+
+project_author_email_input = StrInput(
+    name="project-author-email",
+    prompt="Project author email",
+    description="Project author email",
+    default=f"{SYSTEM_USER}@gmail.com",
+)
+
+project_description_input = StrInput(
+    name="project-description",
+    description="Project description",
+    prompt="Project description",
+    default="Just another Zrb project",
+)

zrb/builtin/project/create/create.py

@@ -0,0 +1,103 @@
+import os
+
+from zrb.builtin.project._group import project_group
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.project_task import add_project_tasks
+from zrb.builtin.project.create._helper import copy_resource_replacement_mutator
+from zrb.builtin.project.create._input import (
+    project_author_email_input,
+    project_author_name_input,
+    project_description_input,
+    project_name_input,
+)
+from zrb.config.config import version
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task.decorator import python_task
+from zrb.task.resource_maker import ResourceMaker
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_SHELL_SCRIPTS_DIR = os.path.join(
+    os.path.dirname(os.path.dirname(os.path.dirname(_CURRENT_DIR))), "shell-scripts"
+)
+_SYSTEM_USER = os.getenv("USER", "incognito")
+_IMAGE_DEFAULT_NAMESPACE = os.getenv(
+    "PROJECT_IMAGE_DEFAULT_NAMESPACE", "docker.io/" + _SYSTEM_USER
+)
+
+
+@python_task(
+    name="validate",
+    inputs=[project_dir_input],
+    retry=0,
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    if os.path.isfile(os.path.join(project_dir, "zrb_init.py")):
+        raise Exception(f"Project directory already exists: {project_dir}")
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        project_name_input,
+        project_description_input,
+        project_author_name_input,
+        project_author_email_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbProjectDir": "{{input.project_dir}}",
+        "zrbProjectName": "{{input.project_name}}",
+        "zrbProjectDescription": "{{input.project_description}}",
+        "zrbProjectAuthorName": "{{input.project_author_name}}",
+        "zrbProjectAuthorEmail": "{{input.project_author_email}}",
+        "zrbImageDefaultNamespace": _IMAGE_DEFAULT_NAMESPACE,
+        "zrbVersion": version,
+    },
+    replacement_mutator=copy_resource_replacement_mutator,
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{input.project_dir}}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+_add_project_tasks = add_project_tasks.copy()
+_add_project_tasks.add_upstream(copy_resource)
+
+init_git = CmdTask(
+    name="init-git",
+    upstreams=[copy_resource],
+    inputs=[project_dir_input],
+    cmd_path=[
+        os.path.join(_SHELL_SCRIPTS_DIR, "_common-util.sh"),
+        os.path.join(_CURRENT_DIR, "init-git.sh"),
+    ],
+)
+
+
+@python_task(
+    name="create",
+    description="Create a new project",
+    inputs=[
+        project_dir_input,
+        project_name_input,
+        project_description_input,
+        project_author_name_input,
+        project_author_email_input,
+    ],
+    group=project_group,
+    upstreams=[_add_project_tasks, init_git],
+)
+def create_project(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Project created", color="yellow"))
+    task.print_out(colored("Happy coding :)", color="yellow"))
+
+
+runner.register(create_project)

zrb/builtin/project/create/init-git.sh

@@ -0,0 +1,7 @@
+set -e
+cd {{input.project_dir}}
+if [ ! -d .git ]
+then
+    log_info "Initialize git repository"
+    git init
+fi

zrb/builtin/project/create/template/.github/workflows/hello.yml

@@ -0,0 +1,11 @@
+name: "Hello"
+run-name: "Run hello for ${{ github.actor }}"
+on: [push]
+
+jobs:
+  run-command:
+    uses: ./.github/workflows/_zrb.yml
+    with:
+      environment: DEV
+      command: |
+        zrb explain solid

zrb/builtin/project/create/template/README.md

@@ -0,0 +1,66 @@
+# PascalZrbProjectName
+
+PascalZrbProjectName is a [Zrb](https://pypi.org/project/zrb/) project.
+
+There are two directories in the project:
+
+- `_automate`: This directory contains Zrb task definitions
+- `src`: This directory contains all source code and resources.
+
+To learn more about the project, you can visit [Zrb getting started page](https://github.com/state-alchemists/zrb/blob/main/docs/getting-started.md).
+
+# Prerequisites
+
+To start working with PascalZrbProjectName, you need to have:
+
+- Python 3.10 or higher
+- Pip
+- Venv
+
+You can also use [Zrb Docker container](https://github.com/state-alchemists/zrb#-with-docker) if you prefer to work with Docker.
+
+# Getting started
+
+To get started, you need to activate PascalZrbProjectName virtual environment and install a few packages (including Zrb). You can do this by invoking the following command in your terminal:
+
+```bash
+source ./project.sh
+```
+
+Once the virtual environment is activated, you will be able to invoke any Zrb commands.
+
+To make sure that Zrb is accessible, you can try to invoke the following commands:
+
+```bash
+zrb version
+```
+
+# Creating an application
+
+You can add a new application to PascalZrbProjectName by invoking the following command:
+
+```bash
+zrb project add fastapp app
+```
+
+Once the application is created, you can start it by invoking the following command:
+
+```bash
+zrb project <app-name> monolith start
+```
+
+You will be able to find the application under PascalZrbProjectName's `src` directory.
+
+Zrb also allows you to create CRUD entities on your application. Please visit [Zrb's development-to-deployment tutorial](https://github.com/state-alchemists/zrb/blob/main/docs/tutorials/development-to-deployment-low-code.md) to learn more.
+
+# Configuration
+
+To configure PascalZrbProjectName, you need to create a `.env` file.
+
+You can see the default configuration by invoking the following command:
+
+```
+zrb project get-default-env
+```
+
+Once the environment file is updated, you can reload PascalZrbProjectName by invoking `reload` in the terminal.

zrb/builtin/project/create/template/template.env

@@ -0,0 +1,2 @@
+export PROJECT_IMAGE_DEFAULT_NAMESPACE=zrbImageDefaultNamespace
+export PROJECT_PREFER_MICROSERVICES=0

zrb/builtin/say.py

@@ -1,7 +1,7 @@
 import datetime
 import random
 
-from zrb.helper.python_task import show_lines
+from zrb.helper.task import show_lines
 from zrb.helper.typing import Any, List
 from zrb.runner import runner
 from zrb.task.decorator import python_task

zrb/builtin/schedule.py

@@ -1,4 +1,4 @@
-from zrb.builtin.helper.reccuring_action import create_recurring_action
+from zrb.builtin._helper.reccuring_action import create_recurring_action
 from zrb.runner import runner
 from zrb.task.recurring_task import RecurringTask
 from zrb.task.time_watcher import TimeWatcher

zrb/builtin/ubuntu/__init__.py

@@ -0,0 +1,18 @@
+from zrb.builtin.ubuntu._group import ubuntu_group
+from zrb.builtin.ubuntu.install import (
+    install_ubuntu_all,
+    install_ubuntu_essentials,
+    install_ubuntu_tex,
+    install_ubuntu_toys,
+    ubuntu_install_group,
+)
+from zrb.builtin.ubuntu.update import update_ubuntu
+
+assert ubuntu_group
+assert ubuntu_install_group
+assert update_ubuntu
+assert ubuntu_install_group
+assert install_ubuntu_all
+assert install_ubuntu_essentials
+assert install_ubuntu_tex
+assert install_ubuntu_toys

zrb/builtin/ubuntu/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+ubuntu_group = Group(name="ubuntu", description="Ubuntu related commands")

zrb/builtin/ubuntu/install/__init__.py

@@ -0,0 +1,11 @@
+from zrb.builtin.ubuntu.install._group import ubuntu_install_group
+from zrb.builtin.ubuntu.install.all import install_ubuntu_all
+from zrb.builtin.ubuntu.install.essentials import install_ubuntu_essentials
+from zrb.builtin.ubuntu.install.tex import install_ubuntu_tex
+from zrb.builtin.ubuntu.install.toys import install_ubuntu_toys
+
+assert ubuntu_install_group
+assert install_ubuntu_all
+assert install_ubuntu_essentials
+assert install_ubuntu_tex
+assert install_ubuntu_toys

zrb/builtin/ubuntu/install/_group.py

@@ -0,0 +1,6 @@
+from zrb.builtin.ubuntu._group import ubuntu_group
+from zrb.task_group.group import Group
+
+ubuntu_install_group = Group(
+    name="install", description="Install things on ubuntu", parent=ubuntu_group
+)

zrb/builtin/ubuntu/install/all.py

@@ -0,0 +1,50 @@
+from zrb.builtin.devtool.install.aws.aws import install_aws
+from zrb.builtin.devtool.install.docker.docker import install_docker
+from zrb.builtin.devtool.install.gcloud.gcloud import install_gcloud
+from zrb.builtin.devtool.install.gvm.gvm import install_gvm
+from zrb.builtin.devtool.install.helix.helix import install_helix
+from zrb.builtin.devtool.install.helm.helm import install_helm
+from zrb.builtin.devtool.install.kubectl.kubectl import install_kubectl
+from zrb.builtin.devtool.install.nvm.nvm import install_nvm
+from zrb.builtin.devtool.install.pulumi.pulumi import install_pulumi
+from zrb.builtin.devtool.install.pyenv.pyenv import install_pyenv
+from zrb.builtin.devtool.install.sdkman.sdkman import install_sdkman
+from zrb.builtin.devtool.install.selenium.selenium import install_selenium
+from zrb.builtin.devtool.install.terraform.terraform import install_terraform
+from zrb.builtin.devtool.install.tmux.tmux import install_tmux
+from zrb.builtin.devtool.install.zsh.zsh import install_zsh
+from zrb.builtin.ubuntu.install._group import ubuntu_install_group
+from zrb.builtin.ubuntu.install.essentials import install_ubuntu_essentials
+from zrb.builtin.ubuntu.install.tex import install_ubuntu_tex
+from zrb.builtin.ubuntu.install.toys import install_ubuntu_toys
+from zrb.builtin.ubuntu.update import update_ubuntu
+from zrb.runner import runner
+from zrb.task.flow_task import FlowTask
+
+install_ubuntu_all = FlowTask(
+    name="all",
+    group=ubuntu_install_group,
+    description="Install all ubuntu packages",
+    steps=[
+        update_ubuntu,
+        install_ubuntu_essentials,
+        install_ubuntu_toys,
+        install_ubuntu_tex,
+        install_zsh,
+        install_tmux,
+        install_gvm,
+        install_nvm,
+        install_pyenv,
+        install_sdkman,
+        install_aws,
+        install_gcloud,
+        install_docker,
+        install_kubectl,
+        install_terraform,
+        install_helm,
+        install_pulumi,
+        install_helix,
+        install_selenium,
+    ],
+)
+runner.register(install_ubuntu_all)

zrb/builtin/ubuntu/install/essentials.py

@@ -0,0 +1,24 @@
+from zrb.builtin.ubuntu.install._group import ubuntu_install_group
+from zrb.builtin.ubuntu.update import update_ubuntu
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+
+install_ubuntu_essentials = CmdTask(
+    name="essentials",
+    group=ubuntu_install_group,
+    description="Install ubuntu essential packages",
+    cmd=[
+        "sudo apt install -y \\",
+        "build-essential python3-distutils libssl-dev zlib1g-dev \\"
+        "libbz2-dev libreadline-dev libsqlite3-dev libpq-dev python3-dev \\",
+        "llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev \\",
+        "liblzma-dev python3-openssl libblas-dev liblapack-dev rustc \\",
+        "golang gfortran fd-find ripgrep wget curl git ncat zip unzip \\",
+        "cmake make tree tmux zsh neovim xdotool xsel",
+    ],
+    retry_interval=3,
+    preexec_fn=None,
+)
+update_and_install_essentials: CmdTask = install_ubuntu_essentials.copy()
+update_and_install_essentials.add_upstream(update_ubuntu)
+runner.register(update_and_install_essentials)

zrb/builtin/ubuntu/install/tex.py

@@ -0,0 +1,20 @@
+from zrb.builtin.ubuntu.install._group import ubuntu_install_group
+from zrb.builtin.ubuntu.update import update_ubuntu
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+
+install_ubuntu_tex = CmdTask(
+    name="tex",
+    group=ubuntu_install_group,
+    description="Install ubuntu tex packages",
+    cmd=[
+        "sudo apt install -y \\",
+        "texlive-full texlive-latex-base texlive-fonts-recommended \\",
+        "texlive-fonts-extra texlive-latex-extra",
+    ],
+    retry_interval=3,
+    preexec_fn=None,
+)
+update_and_install_tex: CmdTask = install_ubuntu_tex.copy()
+update_and_install_tex.add_upstream(update_ubuntu)
+runner.register(update_and_install_tex)

zrb/builtin/ubuntu/install/toys.py

@@ -0,0 +1,18 @@
+from zrb.builtin.ubuntu.install._group import ubuntu_install_group
+from zrb.builtin.ubuntu.update import update_ubuntu
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+
+install_ubuntu_toys = CmdTask(
+    name="toys",
+    group=ubuntu_install_group,
+    description="Install ubuntu toy packages",
+    cmd=[
+        "sudo apt install -y lolcat cowsay figlet neofetch",
+    ],
+    retry_interval=3,
+    preexec_fn=None,
+)
+update_and_install_toys: CmdTask = install_ubuntu_toys.copy()
+update_and_install_toys.add_upstream(update_ubuntu)
+runner.register(update_and_install_toys)