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

zrb/builtin/group.py

@@ -1,22 +1,48 @@
-from zrb.task_group.group import Group
+import sys
 
-project_group = Group(name="project", description="Project management")
-project_add_group = Group(
-    name="add", description="Add resources to project", parent=project_group
+from zrb.builtin.base64 import base64_group
+from zrb.builtin.devtool import devtool_group, devtool_install_group
+from zrb.builtin.docker import docker_group
+from zrb.builtin.env import env_group
+from zrb.builtin.explain import explain_group
+from zrb.builtin.git import git_group
+from zrb.builtin.md5 import md5_group
+from zrb.builtin.process import process_group, process_pid_group
+from zrb.builtin.project import (
+    project_add_app_group,
+    project_add_fastapp_group,
+    project_add_group,
+    project_add_task_group,
+    project_group,
 )
-env_group = Group(name="env", description="Environment variable management")
-ubuntu_group = Group(name="ubuntu", description="Ubuntu related commands")
-ubuntu_install_group = Group(
-    name="install", description="Install things on ubuntu", parent=ubuntu_group
-)
-explain_group = Group(name="explain", description="Explain things")
-base64_group = Group(name="base64", description="Base64 operations")
-md5_group = Group(name="md5", description="MD5 operations")
-dev_tool_group = Group(name="devtool", description="Developer tools management")
-dev_tool_install_group = Group(
-    name="install", description="Install developer tools", parent=dev_tool_group
-)
-git_group = Group(name="git", description="Git related commands")
-docker_group = Group(name="docker", description="Docker related commands")
-process_group = Group(name="process", description="Process related commands")
-plugin_group = Group(name="plugin", description="Plugin related command")
+from zrb.builtin.ubuntu import ubuntu_group, ubuntu_install_group
+from zrb.helper.accessories.color import colored
+
+_DEPRECATION_WARNING = """
+DEPRECATED: zrb.builtin.group
+User zrb.builtin instead
+
+```python
+from zrb.builtin import project_group
+```
+"""
+
+print(colored(_DEPRECATION_WARNING, color="red", attrs=["bold"]), file=sys.stderr)
+
+assert base64_group
+assert devtool_group
+assert devtool_install_group
+assert docker_group
+assert env_group
+assert explain_group
+assert git_group
+assert md5_group
+assert process_group
+assert process_pid_group
+assert project_group
+assert project_add_group
+assert project_add_app_group
+assert project_add_fastapp_group
+assert project_add_task_group
+assert ubuntu_group
+assert ubuntu_install_group

zrb/builtin/md5/__init__.py

@@ -0,0 +1,7 @@
+from zrb.builtin.md5._group import md5_group
+from zrb.builtin.md5.hash import hash_text_md5
+from zrb.builtin.md5.sum import sum_file_md5
+
+assert md5_group
+assert hash_text_md5
+assert sum_file_md5

zrb/builtin/md5/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+md5_group = Group(name="md5", description="MD5 operations")

zrb/builtin/md5/hash.py

@@ -0,0 +1,21 @@
+import hashlib
+
+from zrb.builtin.md5._group import md5_group
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task_input.str_input import StrInput
+
+
+@python_task(
+    name="hash",
+    group=md5_group,
+    inputs=[StrInput(name="text", shortcut="t", description="Text", default="")],
+    description="Hash md5",
+    retry=0,
+    runner=runner,
+)
+async def hash_text_md5(*args: str, **kwargs: Any):
+    text: str = kwargs.get("text", "")
+    hashed_text = hashlib.md5(text.encode()).hexdigest()
+    return hashed_text

zrb/builtin/md5/sum.py

@@ -0,0 +1,25 @@
+import hashlib
+
+import aiofiles
+
+from zrb.builtin.md5._group import md5_group
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task_input.str_input import StrInput
+
+
+@python_task(
+    name="sum",
+    group=md5_group,
+    inputs=[StrInput(name="file", shortcut="f", description="File", default="")],
+    description="Sum md5 file",
+    retry=0,
+    runner=runner,
+)
+async def sum_file_md5(*args: str, **kwargs: Any):
+    file_path: str = kwargs.get("file", "")
+    async with aiofiles.open(file_path, mode="rb") as file:
+        contents = await file.read()
+    hashed_text = hashlib.md5(contents).hexdigest()
+    return hashed_text

zrb/builtin/process/__init__.py

@@ -0,0 +1,11 @@
+from zrb.builtin.process._group import process_group
+from zrb.builtin.process.pid import (
+    get_process_pid_by_name,
+    get_process_pid_by_port,
+    process_pid_group,
+)
+
+assert process_group
+assert process_pid_group
+assert get_process_pid_by_name
+assert get_process_pid_by_port

zrb/builtin/process/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+process_group = Group(name="process", description="Process related commands")

zrb/builtin/process/pid/__init__.py

@@ -0,0 +1,7 @@
+from zrb.builtin.process.pid._group import process_pid_group
+from zrb.builtin.process.pid.get_by_name import get_process_pid_by_name
+from zrb.builtin.process.pid.get_by_port import get_process_pid_by_port
+
+assert process_pid_group
+assert get_process_pid_by_name
+assert get_process_pid_by_port

zrb/builtin/process/pid/_group.py

@@ -0,0 +1,6 @@
+from zrb.builtin.process._group import process_group
+from zrb.task_group.group import Group
+
+process_pid_group = Group(
+    name="pid", parent=process_group, description="PID related commands"
+)

zrb/builtin/process/pid/get_by_name.py

@@ -0,0 +1,22 @@
+from zrb.builtin.process._group import process_group
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task_input.str_input import StrInput
+
+get_process_pid_by_name = CmdTask(
+    name="get-pid-by-name",
+    group=process_group,
+    description="Get PID by name",
+    inputs=[
+        StrInput(
+            name="name",
+            shortcut="n",
+            default="python",
+            description="Process name to be checked",
+            prompt="Process name to be checked",
+        )
+    ],
+    cmd="pgrep {{ input.name }}",
+    checking_interval=3,
+)
+runner.register(get_process_pid_by_name)

zrb/builtin/process/pid/get_by_port.py

@@ -0,0 +1,22 @@
+from zrb.builtin.process._group import process_group
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task_input.int_input import IntInput
+
+get_process_pid_by_port = CmdTask(
+    name="get-pid-by-port",
+    group=process_group,
+    description="Get PID by port",
+    inputs=[
+        IntInput(
+            name="port",
+            shortcut="p",
+            default="8080",
+            description="Port to be checked",
+            prompt="Port to be checked",
+        )
+    ],
+    cmd="lsof -i :{{ input.port }} -n -P | awk 'NR>1 {print $2}'",
+    checking_interval=3,
+)
+runner.register(get_process_pid_by_port)

zrb/builtin/project/__init__.py

@@ -0,0 +1,35 @@
+from zrb.builtin.project._group import project_group
+from zrb.builtin.project.add import (
+    add_cmd_task,
+    add_docker_compose_task,
+    add_fastapp_application,
+    add_fastapp_crud,
+    add_fastapp_field,
+    add_fastapp_module,
+    add_plugin,
+    add_project_tasks,
+    add_python_app,
+    add_python_task,
+    project_add_app_group,
+    project_add_fastapp_group,
+    project_add_group,
+    project_add_task_group,
+)
+from zrb.builtin.project.create import create_project
+
+assert project_group
+assert project_add_group
+assert project_add_app_group
+assert project_add_fastapp_group
+assert project_add_task_group
+assert create_project
+assert add_plugin
+assert add_project_tasks
+assert add_cmd_task
+assert add_docker_compose_task
+assert add_fastapp_application
+assert add_fastapp_crud
+assert add_fastapp_module
+assert add_fastapp_field
+assert add_python_task
+assert add_python_app

zrb/builtin/project/_group.py

@@ -0,0 +1,3 @@
+from zrb.task_group.group import Group
+
+project_group = Group(name="project", description="Project management")

zrb/builtin/project/_helper.py

@@ -0,0 +1,98 @@
+import os
+
+from zrb.builtin.project._input import project_dir_input
+from zrb.helper import util
+from zrb.helper.accessories.color import colored
+from zrb.helper.codemod.add_assert_resource import add_assert_resource
+from zrb.helper.codemod.add_import_module import add_import_module
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, List, Optional
+from zrb.task.any_task import AnyTask
+from zrb.task.decorator import python_task
+from zrb.task.task import Task
+from zrb.task_input.any_input import AnyInput
+
+
+@typechecked
+def validate_existing_project_dir(project_dir: str):
+    if not os.path.isfile(os.path.join(project_dir, "zrb_init.py")):
+        raise Exception(f"Not a project: {project_dir}")
+
+
+@typechecked
+def validate_inexisting_automation(project_dir: str, automation_name: str):
+    validate_inexisting_automation_package(project_dir, automation_name)
+    validate_inexisting_automation_module(project_dir, automation_name)
+
+
+@typechecked
+def validate_inexisting_automation_package(project_dir: str, package_name: str):
+    package_dir = os.path.join(
+        project_dir, "_automate", f"{util.to_snake_case(package_name)}"
+    )
+    if os.path.exists(package_dir):
+        raise Exception(f"Automation package already exists: {package_dir}")
+
+
+@typechecked
+def validate_inexisting_automation_module(project_dir: str, module_name: str):
+    module_file = os.path.join(
+        project_dir, "_automate", f"{util.to_snake_case(module_name)}.py"
+    )
+    if os.path.exists(module_file):
+        raise Exception(f"Automation module already exists: {module_file}")
+
+
+@typechecked
+async def register_module_to_project(
+    project_dir: str, module_path: str, alias: Optional[str] = None
+):
+    zrb_init_path = os.path.join(project_dir, "zrb_init.py")
+    code = await read_text_file_async(zrb_init_path)
+    if alias is None:
+        alias = module_path.split(".")[-1]
+    code = add_import_module(code=code, module_path=module_path, alias=alias)
+    code = add_assert_resource(code, alias)
+    await write_text_file_async(zrb_init_path, code)
+    return True
+
+
+@typechecked
+def create_register_module(
+    module_path: str,
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None,
+    alias: Optional[str] = None,
+    task_name: str = "register-module",
+) -> Task:
+    @python_task(
+        name=task_name,
+        inputs=[project_dir_input] + inputs if inputs is not None else [],
+        upstreams=upstreams if upstreams is not None else [],
+    )
+    async def register_module(*args: Any, **kwargs: Any):
+        task: Task = kwargs.get("_task")
+        project_dir = kwargs.get("project_dir")
+        validate_existing_project_dir(project_dir)
+        rendered_module_path = task.render_str(module_path)
+        rendered_alias: Optional[str] = None
+        if alias is not None:
+            rendered_alias = task.render_str(alias)
+        module_import_label = _get_module_import_label(
+            module_path=rendered_module_path, alias=rendered_alias
+        )
+        task.print_out(colored(module_import_label, color="yellow"))
+        await register_module_to_project(
+            project_dir=project_dir,
+            module_path=rendered_module_path,
+            alias=rendered_alias,
+        )
+
+    return register_module
+
+
+def _get_module_import_label(module_path: str, alias: Optional[str]):
+    if alias == "" or alias is None:
+        return module_path
+    return f"{module_path} as {alias}"

zrb/builtin/project/_input.py

@@ -0,0 +1,13 @@
+import os
+
+from zrb.task_input.str_input import StrInput
+
+SYSTEM_USER = os.getenv("USER", "incognito")
+
+project_dir_input = StrInput(
+    name="project-dir",
+    shortcut="d",
+    description="Project directory",
+    prompt="Project directory",
+    default=".",
+)

zrb/builtin/project/add/__init__.py

@@ -0,0 +1,37 @@
+from zrb.builtin.project.add._group import project_add_group
+from zrb.builtin.project.add.app import (
+    add_app_generator,
+    add_python_app,
+    project_add_app_group,
+)
+from zrb.builtin.project.add.fastapp import (
+    add_fastapp_application,
+    add_fastapp_crud,
+    add_fastapp_field,
+    add_fastapp_module,
+    project_add_fastapp_group,
+)
+from zrb.builtin.project.add.plugin import add_plugin
+from zrb.builtin.project.add.project_task import add_project_tasks
+from zrb.builtin.project.add.task import (
+    add_cmd_task,
+    add_docker_compose_task,
+    add_python_task,
+    project_add_task_group,
+)
+
+assert project_add_group
+assert project_add_app_group
+assert project_add_fastapp_group
+assert project_add_task_group
+assert add_app_generator
+assert add_python_app
+assert add_fastapp_application
+assert add_fastapp_crud
+assert add_fastapp_field
+assert add_fastapp_module
+assert add_plugin
+assert add_project_tasks
+assert add_cmd_task
+assert add_docker_compose_task
+assert add_python_task

zrb/builtin/project/add/_group.py

@@ -0,0 +1,6 @@
+from zrb.builtin.project._group import project_group
+from zrb.task_group.group import Group
+
+project_add_group = Group(
+    name="add", description="Add resources to project", parent=project_group
+)

zrb/builtin/project/add/app/__init__.py

@@ -0,0 +1,7 @@
+from zrb.builtin.project.add.app._group import project_add_app_group
+from zrb.builtin.project.add.app.generator import add_app_generator
+from zrb.builtin.project.add.app.python import add_python_app
+
+assert project_add_app_group
+assert add_app_generator
+assert add_python_app

zrb/builtin/project/add/app/_group.py

@@ -0,0 +1,6 @@
+from zrb.builtin.project.add._group import project_add_group
+from zrb.task_group.group import Group
+
+project_add_app_group = Group(
+    name="app", description="Add app/generator to project", parent=project_add_group
+)

zrb/builtin/project/add/app/generator/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.app.generator.generator import add_app_generator
+
+assert add_app_generator

zrb/builtin/project/add/app/generator/_helper.py

@@ -0,0 +1,15 @@
+import os
+
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_kebab_case, to_snake_case
+
+
+@typechecked
+def validate_existing_package(project_dir: str, package_name: str):
+    kebab_package_name = to_kebab_case(package_name)
+    snake_package_name = to_snake_case(package_name)
+    package_init_path = os.path.join(
+        project_dir, "src", kebab_package_name, "src", snake_package_name, "__init__.py"
+    )
+    if not os.path.isfile(package_init_path):
+        raise Exception(f"Package not exists: {package_init_path}")

zrb/builtin/project/add/app/generator/_input.py

@@ -0,0 +1,31 @@
+from zrb.helper.accessories.name import get_random_name
+from zrb.task_input.int_input import IntInput
+from zrb.task_input.str_input import StrInput
+
+package_name_input = StrInput(
+    name="package-name",
+    description="Package name",
+    prompt="Package name",
+    default=get_random_name(),
+)
+
+generator_name_input = StrInput(
+    name="generator-name",
+    description="Generator name",
+    prompt="Generator name",
+    default=get_random_name(),
+)
+
+generator_base_image_input = StrInput(
+    name="generator-base-image",
+    description="Base image",
+    prompt="Base image",
+    default="python:3.10-slim",
+)
+
+generator_app_port_input = IntInput(
+    name="generator-app-port",
+    description="Default app port",
+    prompt="Default app port",
+    default="8080",
+)

zrb/builtin/project/add/app/generator/generator.py

@@ -0,0 +1,106 @@
+import os
+
+from zrb.builtin.project._helper import validate_existing_project_dir
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.app._group import project_add_app_group
+from zrb.builtin.project.add.app.generator._helper import validate_existing_package
+from zrb.builtin.project.add.app.generator._input import (
+    generator_app_port_input,
+    generator_base_image_input,
+    generator_name_input,
+    package_name_input,
+)
+from zrb.helper.accessories.color import colored
+from zrb.helper.codemod.add_assert_resource import add_assert_resource
+from zrb.helper.codemod.add_import_module import add_import_module
+from zrb.helper.typing import Any
+from zrb.helper.util import to_kebab_case, to_snake_case
+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, package_name_input],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    package_name = kwargs.get("package_name")
+    validate_existing_package(project_dir, package_name)
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        package_name_input,
+        generator_name_input,
+        generator_base_image_input,
+        generator_app_port_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbPackageName": "{{input.package_name}}",
+        "zrbGeneratorName": "{{input.generator_name}}",
+        "zrbGeneratorBaseImage": "{{input.generator_base_image}}",
+        "zrbGeneratorAppPort": "{{input.generator_app_port}}",
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/deployment/venv",
+        "*/__pycache__",
+    ],
+)
+
+
+@python_task(
+    name="register-generator",
+    inputs=[
+        project_dir_input,
+        package_name_input,
+        generator_name_input,
+    ],
+    upstreams=[copy_resource],
+)
+def register_generator(*args: Any, **kwargs: Any):
+    task = kwargs.get("_task")
+    project_dir = kwargs.get("project_dir")
+    package_name = kwargs.get("package_name")
+    generator_name = kwargs.get("generator_name")
+    kebab_package_name = to_kebab_case(package_name)
+    snake_package_name = to_snake_case(package_name)
+    snake_generator_name = to_snake_case(generator_name)
+    package_init_path = os.path.join(
+        project_dir, "src", kebab_package_name, "src", snake_package_name, "__init__.py"
+    )
+    with open(package_init_path, "r") as f:
+        code = f.read()
+    new_code = add_import_module(
+        code=code,
+        module_path=f"{snake_package_name}.{snake_generator_name}",
+        alias=snake_generator_name,
+    )
+    new_code = add_assert_resource(code=new_code, resource=snake_generator_name)
+    with open(package_init_path, "w") as f:
+        f.write(new_code)
+    task.print_out(colored("Register generator", color="yellow"))
+
+
+@python_task(
+    name="generator",
+    group=project_add_app_group,
+    description="Add app generator",
+    upstreams=[
+        register_generator,
+    ],
+    runner=runner,
+)
+async def add_app_generator(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Appp generator added", color="yellow"))

zrb/builtin/project/add/app/generator/template/src/kebab-zrb-package-name/src/snake_zrb_package_name/snake_zrb_generator_name/__init__.py

@@ -0,0 +1,3 @@
+from .snake_zrb_generator_name import add_snake_zrb_generator_name
+
+assert add_snake_zrb_generator_name

zrb/builtin/project/add/app/generator/template/src/kebab-zrb-package-name/src/snake_zrb_package_name/snake_zrb_generator_name/_input.py

@@ -0,0 +1,62 @@
+import os
+
+from zrb.task_input.int_input import IntInput
+from zrb.task_input.str_input import StrInput
+
+SYSTEM_USER = os.getenv("USER", "incognito")
+
+app_name_input = StrInput(
+    name="app-name",
+    shortcut="a",
+    description="App name",
+    prompt="App name",
+    default="app",
+)
+
+app_author_name_input = StrInput(
+    name="app-author-name",
+    prompt="App author name",
+    description="App author name",
+    default=SYSTEM_USER,
+)
+
+app_author_email_input = StrInput(
+    name="app-author-email",
+    prompt="App author email",
+    description="App author email",
+    default=f"{SYSTEM_USER}@gmail.com",
+)
+
+app_description_input = StrInput(
+    name="app-description",
+    description="App description",
+    prompt="App description",
+    default="Just another app",
+)
+
+app_image_default_namespace = os.getenv(
+    "PROJECT_IMAGE_DEFAULT_NAMESPACE", "docker.io/" + SYSTEM_USER
+)
+app_image_name_input = StrInput(
+    name="app-image-name",
+    description="App image name",
+    prompt="App image name",
+    default=app_image_default_namespace
+    + "/"
+    + "{{util.to_kebab_case(input.app_name)}}",  # noqa
+)
+
+http_port_input = IntInput(
+    name="http-port",
+    shortcut="p",
+    description="HTTP port",
+    prompt="HTTP port",
+    default="zrbGeneratorAppPort",
+)
+
+env_prefix_input = StrInput(
+    name="env-prefix",
+    description="OS environment prefix",
+    prompt="OS environment prefix",
+    default='{{util.to_snake_case(util.coalesce(input.app_name, input.task_name, "MY")).upper()}}',  # noqa
+)