zrb 0.0.86__py3-none-any.whl → 0.0.88__py3-none-any.whl

zrb/__init__.py

@@ -9,6 +9,7 @@ from .task.port_checker import PortChecker
 from .task.path_checker import PathChecker
 from .task.resource_maker import ResourceMaker, Replacement, ReplacementMutator
 from .task.flow_task import FlowTask, FlowNode
+from .task_input.any_input import AnyInput
 from .task_input.task_input import Input
 from .task_input.bool_input import BoolInput
 from .task_input.choice_input import ChoiceInput
@@ -19,7 +20,7 @@ from .task_input.str_input import StrInput
 from .task_env.env import Env
 from .task_env.env_file import EnvFile
 from .task_group.group import Group
-from .builtin import _group as builtin_group
+from .builtin import group as builtin_group
 from .helper.default_env import inject_default_env
 
 
@@ -38,6 +39,7 @@ assert FlowTask
 assert FlowNode
 assert Replacement
 assert ReplacementMutator
+assert AnyInput
 assert Input
 assert BoolInput
 assert ChoiceInput

zrb/action/runner.py

@@ -1,4 +1,5 @@
 from typing import Any, Callable, Iterable, List, Mapping, Union
+from typeguard import typechecked
 from ..task_group.group import Group as TaskGroup
 from ..task.any_task import AnyTask
 import click
@@ -7,6 +8,7 @@ import sys
 CliSubcommand = Union[click.Group, click.Command]
 
 
+@typechecked
 class Runner():
     '''
     Runner class.
@@ -32,7 +34,9 @@ class Runner():
                 cli.add_command(subcommand)
         return cli
 
-    def _create_cli_subcommand(self, task: AnyTask) -> click.Group:
+    def _create_cli_subcommand(
+        self, task: AnyTask
+    ) -> Union[click.Group, click.Command]:
         subcommand: CliSubcommand = self._create_cli_command(task)
         task_group = task._group
         while task_group is not None:
@@ -82,9 +86,9 @@ class Runner():
         # if there are inputs with the same name, choose the first.
         registered_input: Mapping[str, bool] = {}
         for task_input in task_inputs:
-            if task_input.name in registered_input:
+            if task_input.get_name() in registered_input:
                 continue
-            registered_input[task_input.name] = True
+            registered_input[task_input.get_name()] = True
             param_decl = task_input.get_param_decl()
             options = task_input.get_options()
             command.params.append(click.Option(param_decl, **options))

zrb/builtin/__init__.py

@@ -1,4 +1,4 @@
-from . import _group as group
+from . import group
 from . import base64
 from . import env
 from . import eval

zrb/builtin/base64.py

@@ -1,5 +1,5 @@
 from typing import Any
-from ._group import base64_group
+from .group import base64_group
 from ..task.decorator import python_task
 from ..task_input.str_input import StrInput
 from ..runner import runner

zrb/builtin/devtool/devtool_install.py

@@ -1,12 +1,13 @@
 from typing import Any, Callable
+from typeguard import typechecked
 from ...config.config import get_current_shell
-from .._group import dev_tool_install_group
 from ...task.task import Task
 from ...task.flow_task import FlowTask, FlowNode
 from ...task_input.str_input import StrInput
 from ...task_input.bool_input import BoolInput
 from ...runner import runner
 from ...helper.file.text import read_text_file_async, write_text_file_async
+from ..group import dev_tool_install_group
 import os
 
 dir_path = os.path.dirname(__file__)
@@ -28,6 +29,7 @@ terminal_config_file_input = StrInput(
 ###############################################################################
 
 
+@typechecked
 def write_config(
     template_file: str, config_file: str, remove_old_config: bool = False
 ) -> Callable[..., Any]:
@@ -66,7 +68,7 @@ install_gvm = FlowTask(
         StrInput(
             name='go-default-version',
             description='Go default version',
-            default='go1.14'
+            default='go1.21'
         ),
         terminal_config_file_input,
     ],
@@ -427,9 +429,9 @@ install_helix = FlowTask(
                 name='create-helix-theme',
                 run=write_config(
                     template_file=os.path.join(
-                        dir_path, 'helix', 'resource', 'themes', 'gruvbox_transparent.toml' # noqa
+                        dir_path, 'helix', 'resource', 'themes', 'gruvbox_transparent.toml'  # noqa
                     ),
-                    config_file='~/.config/helix/themes/gruvbox_transparent.toml', # noqa
+                    config_file='~/.config/helix/themes/gruvbox_transparent.toml',  # noqa
                     remove_old_config=True
                 ),
                 preexec_fn=None
@@ -445,6 +447,13 @@ install_helix = FlowTask(
                 ),
                 preexec_fn=None
             ),
+            FlowNode(
+                name='install-language-server',
+                cmd_path=os.path.join(
+                    dir_path, 'helix', 'install-language-server.sh'
+                ),
+                preexec_fn=None
+            ),
         ],
     ],
     retry=0

zrb/builtin/devtool/helix/install-language-server.sh

@@ -0,0 +1,33 @@
+set +e
+
+pip --version
+if [ "$?" = 0 ]
+then
+    echo "Install python language server"
+    pip install -U 'python-lsp-server[all]'
+else
+    echo "Cannot install python language server, is pip installed?"
+fi
+
+npm --version
+if [ "$?" = 0 ]
+then
+    echo "Install docker language server"
+    npm install -g dockerfile-language-server-nodejs
+else
+    echo "Cannot install docker language server, is npm installed?"
+fi
+
+go version
+if [ "$?" = 0 ]
+then
+    echo "Install go language server"
+    go install golang.org/x/tools/gopls@latest          # LSP
+    go install github.com/go-delve/delve/cmd/dlv@latest # Debugger
+    go install golang.org/x/tools/cmd/goimports@latest  # Formatter
+else
+    echo "Cannot install go language server, is go installed?"
+fi
+
+set -e
+echo "Visit https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers for more information."

zrb/builtin/env.py

@@ -1,5 +1,5 @@
-from typing import Any, Mapping
-from ._group import env_group
+from typing import Any, List
+from .group import env_group
 from ..helper.accessories.color import colored
 from ..task.decorator import python_task
 from ..task.task import Task
@@ -22,9 +22,12 @@ async def get(*args: Any, **kwargs: Any):
     names = list(env_map.keys())
     names.sort()
     colored_equal = colored('=', color='grey', attrs=['dark'])
+    env_lines: List[str] = []
     for name in names:
         value = env_map[name]
         colored_name = colored(name, color='green', attrs=['bold'])
         colored_value = colored(value, attrs=['bold'])
-        task.print_out(f'{colored_name}{colored_equal}{colored_value}')
+        env_lines.append(f'{colored_name}{colored_equal}{colored_value}')
+    line_separator = '\n    '
+    task.print_out(line_separator + line_separator.join(env_lines))
     return env_map

zrb/builtin/explain.py

@@ -1,10 +1,12 @@
 from typing import Any
-from ._group import explain_group
+from typeguard import typechecked
+from .group import explain_group
 from ..task.decorator import python_task
 from ..task.task import Task
 from ..runner import runner
 
 
+@typechecked
 def show_lines(task: Task, *lines: str):
     separator = '\n    '
     task.print_out(

zrb/builtin/generator/__init__.py

@@ -1,7 +1,5 @@
-from ._common import helper
-from ._common import task_input
-from ._common import task_factory
-from .project_task import task_factory as project_task_factory
+from . import common
+from . import project_task
 from .project.create import create_project
 from .cmd_task.add import add_cmd_task
 from .docker_compose_task.add import add_docker_compose_task
@@ -14,10 +12,8 @@ from .fastapp_field import add as add_fastapp_field
 from .pip_package import add as add_pip_package
 from .app_generator import add as add_app_generator
 
-assert helper
-assert task_input
-assert task_factory
-assert project_task_factory
+assert common
+assert project_task
 assert create_project
 assert add_cmd_task
 assert add_docker_compose_task

zrb/builtin/generator/app_generator/add.py

@@ -1,16 +1,16 @@
 from typing import Any
-from ..._group import project_add_group
+from ..common.task_input import project_dir_input
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_factory import create_register_module
+from ...group import project_add_group
 from ....task.decorator import python_task
 from ....task.task import Task
 from ....task.resource_maker import ResourceMaker
 from ....task_input.str_input import StrInput
 from ....helper.accessories.name import get_random_name
 from ....runner import runner
-from .._common.task_input import project_dir_input
-from .._common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
-)
-from .._common.task_factory import create_register_module
 
 import os
 
@@ -25,6 +25,13 @@ template_name_input = StrInput(
     default=get_random_name()
 )
 
+template_base_image_input = StrInput(
+    name='template-base-image',
+    shortcut='i',
+    prompt='Base image',
+    default='python:3.10-slim'
+)
+
 
 ###############################################################################
 # Task Definitions
@@ -50,10 +57,12 @@ copy_resource = ResourceMaker(
     inputs=[
         project_dir_input,
         template_name_input,
+        template_base_image_input,
     ],
     upstreams=[validate],
     replacements={
         'zrbMetaTemplateName': '{{input.template_name}}',
+        'zrbMetaTemplateBaseImage': '{{input.template_base_image}}',
     },
     template_path=os.path.join(CURRENT_DIR, 'template'),
     destination_path='{{ input.project_dir }}',

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/add.py

@@ -1,15 +1,27 @@
 from typing import Any
-from zrb.builtin import group
+from zrb.builtin.group import project_add_group
 from zrb import Task, python_task, ResourceMaker, runner
-from zrb.helper import util
-from zrb.builtin.generator import (
-    task_input, task_factory, helper, project_task_factory as ptask_factory
+from zrb.builtin.generator.common.task_input import (
+    project_dir_input, app_name_input, app_image_name_input, env_prefix_input,
+    http_port_input
+)
+from zrb.builtin.generator.common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from zrb.builtin.generator.common.task_factory import create_register_module
+from zrb.builtin.generator.project_task.task_factory import (
+    create_ensure_project_tasks, create_add_build_images_upstream,
+    create_add_deploy_upstream, create_add_destroy_upstream,
+    create_add_push_images_upstream, create_add_remove_containers_upstream,
+    create_add_start_containers_upstream, create_add_start_upstream,
+    create_add_stop_containers_upstream
 )
 
 import os
 
 CURRENT_DIR = os.path.dirname(__file__)
 SNAKE_APP_NAME_TPL = '{{util.to_snake_case(input.app_name)}}'
+KEBAB_APP_NAME_TPL = '{{util.to_kebab_case(app_name)}}'
 
 ###############################################################################
 # Task Definitions
@@ -19,18 +31,16 @@ SNAKE_APP_NAME_TPL = '{{util.to_snake_case(input.app_name)}}'
 @python_task(
     name='validate',
     inputs=[
-        task_input.project_dir_input,
-        task_input.app_name_input
+        project_dir_input,
+        app_name_input
     ],
 )
 async def validate(*args: Any, **kwargs: Any):
     project_dir = kwargs.get('project_dir')
-    helper.validate_existing_project_dir(project_dir)
+    validate_existing_project_dir(project_dir)
     app_name = kwargs.get('app_name')
-    helper.validate_inexisting_automation(project_dir, app_name)
-    source_dir = os.path.join(
-        project_dir, 'src', f'{util.to_kebab_case(app_name)}'
-    )
+    validate_inexisting_automation(project_dir, app_name)
+    source_dir = os.path.join(project_dir, 'src', f'{KEBAB_APP_NAME_TPL}')
     if os.path.exists(source_dir):
         raise Exception(f'Source already exists: {source_dir}')
 
@@ -38,11 +48,11 @@ async def validate(*args: Any, **kwargs: Any):
 copy_resource = ResourceMaker(
     name='copy-resource',
     inputs=[
-        task_input.project_dir_input,
-        task_input.app_name_input,
-        task_input.app_image_name_input,
-        task_input.http_port_input,
-        task_input.env_prefix_input,
+        project_dir_input,
+        app_name_input,
+        app_image_name_input,
+        http_port_input,
+        env_prefix_input,
     ],
     upstreams=[validate],
     replacements={
@@ -59,114 +69,114 @@ copy_resource = ResourceMaker(
     ]
 )
 
-register_local_module = task_factory.create_register_module(
+register_local_module = create_register_module(
     module_path=f'_automate.{SNAKE_APP_NAME_TPL}.local',
     alias=f'{SNAKE_APP_NAME_TPL}_local',
-    inputs=[task_input.app_name_input],
+    inputs=[app_name_input],
     upstreams=[copy_resource]
 )
 
-register_container_module = task_factory.create_register_module(
+register_container_module = create_register_module(
     module_path=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     alias=f'{SNAKE_APP_NAME_TPL}_container',
-    inputs=[task_input.app_name_input],
+    inputs=[app_name_input],
     upstreams=[register_local_module]
 )
 
-register_image_module = task_factory.create_register_module(
+register_image_module = create_register_module(
     module_path=f'_automate.{SNAKE_APP_NAME_TPL}.image',
     alias=f'{SNAKE_APP_NAME_TPL}_image',
-    inputs=[task_input.app_name_input],
+    inputs=[app_name_input],
     upstreams=[register_container_module]
 )
 
-register_deployment_module = task_factory.create_register_module(
+register_deployment_module = create_register_module(
     module_path=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
     alias=f'{SNAKE_APP_NAME_TPL}_deployment',
-    inputs=[task_input.app_name_input],
+    inputs=[app_name_input],
     upstreams=[register_image_module]
 )
 
-ensure_project_tasks = ptask_factory.create_ensure_project_tasks(
+ensure_project_tasks = create_ensure_project_tasks(
     upstreams=[copy_resource]
 )
 
-add_start = ptask_factory.create_add_start_upstream(
+add_start_upstream = create_add_start_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.local',
     upstream_task_var=f'start_{SNAKE_APP_NAME_TPL}',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_start_container = ptask_factory.create_add_start_containers_upstream(
+add_start_container_upstream = create_add_start_containers_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     upstream_task_var=f'start_{SNAKE_APP_NAME_TPL}_container',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_stop_container = ptask_factory.create_add_stop_containers_upstream(
+add_stop_container_upstream = create_add_stop_containers_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     upstream_task_var=f'stop_{SNAKE_APP_NAME_TPL}_container',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_remove_container = ptask_factory.create_add_remove_containers_upstream(
+add_remove_container_upstream = create_add_remove_containers_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.container',
     upstream_task_var=f'remove_{SNAKE_APP_NAME_TPL}_container',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_build_image = ptask_factory.create_add_build_images_upstream(
+add_build_image_upstream = create_add_build_images_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.image',
     upstream_task_var=f'build_{SNAKE_APP_NAME_TPL}_image',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_push_image = ptask_factory.create_add_push_images_upstream(
+add_push_image_upstream = create_add_push_images_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.image',
     upstream_task_var=f'push_{SNAKE_APP_NAME_TPL}_image',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_deploy = ptask_factory.create_add_deploy_upstream(
+add_deploy_upstream = create_add_deploy_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
     upstream_task_var=f'deploy_{SNAKE_APP_NAME_TPL}',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
-add_destroy = ptask_factory.create_add_destroy_upstream(
+add_destroy_upstream = create_add_destroy_upstream(
     upstream_module=f'_automate.{SNAKE_APP_NAME_TPL}.deployment',
     upstream_task_var=f'destroy_{SNAKE_APP_NAME_TPL}',
     upstreams=[ensure_project_tasks],
-    inputs=[task_input.app_name_input]
+    inputs=[app_name_input]
 )
 
 
 @python_task(
-    name='simple-python-app',
-    group=group.project_add_group,
+    name='kebab-zrb-meta-template-name',
+    group=project_add_group,
     upstreams=[
         register_local_module,
         register_container_module,
         register_image_module,
         register_deployment_module,
-        add_start,
-        add_start_container,
-        add_stop_container,
-        add_remove_container,
-        add_build_image,
-        add_push_image,
-        add_deploy,
-        add_destroy
+        add_start_upstream,
+        add_start_container_upstream,
+        add_stop_container_upstream,
+        add_remove_container_upstream,
+        add_build_image_upstream,
+        add_push_image_upstream,
+        add_deploy_upstream,
+        add_destroy_upstream
     ],
     runner=runner
 )
-async def add_simple_python_app(*args: Any, **kwargs: Any):
+async def snake_zrb_meta_template_name(*args: Any, **kwargs: Any):
     task: Task = kwargs.get('_task')
     task.print_out('Success')

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/cmd/app-start.sh

@@ -1,6 +1 @@
-PYTHONUNBUFFERED=1
-echo "Install packages"
-pip install -r requirements.txt
-
-echo "Start app"
-uvicorn main:app --host {{env.get("APP_HOST", "0.0.0.0")}} --port {{env.get("APP_PORT", "8080")}}
+go run main.go

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/container.py

@@ -1,7 +1,7 @@
 from zrb import (
     DockerComposeTask, Env, EnvFile, HTTPChecker, ServiceConfig, runner
 )
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import (
     RESOURCE_DIR, APP_DIR, local_input, host_input, https_input
 )

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/deployment.py

@@ -1,5 +1,5 @@
-from zrb import CmdTask, Env, EnvFile, IntInput, StrInput, ChoiceInput, runner
-from zrb.builtin._group import project_group
+from zrb import CmdTask, Env, EnvFile, IntInput, StrInput, runner
+from zrb.builtin.group import project_group
 from .image import push_snake_zrb_app_name_image, image_input, image_env
 from ._common import (
     CURRENT_DIR, DEPLOYMENT_DIR, TEMPLATE_ENV_FILE_NAME

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/image.py

@@ -1,5 +1,5 @@
 from zrb import DockerComposeTask, Env, StrInput, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import (
     RESOURCE_DIR, local_input
 )

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/_automate/snake_zrb_app_name/local.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, Env, EnvFile, HTTPChecker, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from ._common import (
     CURRENT_DIR, APP_DIR, TEMPLATE_ENV_FILE_NAME,
     local_input, host_input, https_input
@@ -10,7 +10,9 @@ import os
 # Env File Definitions
 ###############################################################################
 
-app_env_file = EnvFile(env_file=TEMPLATE_ENV_FILE_NAME, prefix='ZRB_ENV_PREFIX')
+app_env_file = EnvFile(
+    env_file=TEMPLATE_ENV_FILE_NAME, prefix='ZRB_ENV_PREFIX'
+)
 
 ###############################################################################
 # Task Definitions

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/.gitignore

@@ -1,3 +1,5 @@
 .env
 __pycache__
 .venv
+web-server
+main

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/Dockerfile

@@ -1,7 +1,12 @@
-FROM python:3.10-slim
+FROM golang:1.21 as build
+WORKDIR /app
+COPY . .
+RUN go build -o web-server main.go
+
+
+FROM zrbMetaTemplateBaseImage
 ENV APP_MESSAGE "Hello, world!"
 ENV APP_PORT 8080
-WORKDIR /home
-COPY . .
-RUN pip install -r requirements.txt
-CMD uvicorn main:app --host "0.0.0.0" --port "$APP_PORT"
+WORKDIR /app
+COPY --from=build /app /app
+CMD ./web-server

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/go.work

@@ -0,0 +1 @@
+go 1.21.0

zrb/builtin/generator/app_generator/template/_automate/snake_zrb_meta_template_name/template/src/kebab-zrb-app-name/src/main.go

@@ -0,0 +1,28 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"net/http"
+	"os"
+)
+
+func main() {
+	// Get configurations
+	appPort := os.Getenv("APP_PORT")
+	if appPort == "" {
+		appPort = "8080"
+	}
+	appMessage := os.Getenv("APP_MESSAGE")
+	if appMessage == "" {
+		appMessage = "Hello world"
+	}
+
+	// Define handler
+	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprint(w, appMessage)
+	})
+	// Listen and serve
+	fmt.Printf("Listening on port %s\n", appPort)
+	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", appPort), nil))
+}

zrb/builtin/generator/cmd_task/add.py

@@ -1,14 +1,14 @@
 from typing import Any
-from ..._group import project_add_group
+from ..common.task_input import project_dir_input, task_name_input
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_factory import create_register_module
+from ...group import project_add_group
 from ....task.task import Task
 from ....task.decorator import python_task
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
-from .._common.task_input import project_dir_input, task_name_input
-from .._common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
-)
-from .._common.task_factory import create_register_module
 
 import os
 

zrb/builtin/generator/cmd_task/template/_automate/snake_zrb_task_name.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 
 ###############################################################################
 # Task Definitions