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

zrb/builtin/generator/pip_package/add.py

@@ -1,18 +1,18 @@
 from typing import Any
-from ..._group import project_add_group
-from ....task.decorator import python_task
-from ....task.task import Task
-from ....task.resource_maker import ResourceMaker
-from ....runner import runner
-from .._common.task_input import (
+from ..common.task_input import (
     project_dir_input, package_name_input, package_description_input,
     package_homepage_input, package_bug_tracker_input,
     package_author_name_input, package_author_email_input
 )
-from .._common.helper import (
+from ..common.helper import (
     validate_existing_project_dir, validate_inexisting_automation
 )
-from .._common.task_factory import create_register_module
+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 ....runner import runner
 
 import os
 

zrb/builtin/generator/pip_package/template/_automate/snake_zrb_package_name/local.py

@@ -1,5 +1,5 @@
 from zrb import CmdTask, runner, StrInput
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 
 import os
 

zrb/builtin/generator/project/create.py

@@ -1,22 +1,28 @@
 from typing import Any, Mapping
-from ..._group import project_group
+from typeguard import typechecked
+from ..common.task_input import project_dir_input, project_name_input
+from ..project_task.task_factory import create_ensure_project_tasks
+from ...group import project_group
 from ....task.cmd_task import CmdTask
 from ....task.decorator import python_task
 from ....task.resource_maker import ResourceMaker
 from ....runner import runner
 from ....config.config import version
-from .._common.task_input import project_dir_input, project_name_input
-from ..project_task.task_factory import create_ensure_project_tasks
 
 import os
 
 CURRENT_DIR = os.path.dirname(__file__)
+SYSTEM_USER = os.getenv('USER', 'incognito')
+IMAGE_DEFAULT_NAMESPACE = os.getenv(
+    'PROJECT_IMAGE_DEFAULT_NAMESPACE', 'docker.io/' + SYSTEM_USER
+)
 
 ###############################################################################
 # Replacement Mutator Definitions
 ###############################################################################
 
 
+@typechecked
 def copy_resource_replacement_mutator(
     task: ResourceMaker, replacements: Mapping[str, str]
 ) -> Mapping[str, str]:
@@ -56,6 +62,7 @@ copy_resource = ResourceMaker(
     replacements={
         'zrbProjectDir': '{{input.project_dir}}',
         'zrbProjectName': '{{input.project_name}}',
+        'zrbImageDefaultNamespace': IMAGE_DEFAULT_NAMESPACE,
         'zrbVersion': version,
     },
     replacement_mutator=copy_resource_replacement_mutator,

zrb/builtin/generator/project/template/template.env

@@ -1,3 +1,3 @@
-export PROJECT_IMAGE_DEFAULT_NAMESPACE=
+export PROJECT_IMAGE_DEFAULT_NAMESPACE=zrbImageDefaultNamespace
 export PROJECT_USE_VENV=1
 export PROJECT_AUTO_INSTALL_PIP=1

zrb/builtin/generator/project_task/task_factory.py

@@ -1,9 +1,11 @@
 from typing import Any, List, Optional
-from .._common.task_input import project_dir_input
-from .._common.task_factory import create_add_upstream
+from typeguard import typechecked
+from ..common.task_input import project_dir_input
+from ..common.task_factory import create_add_upstream
 from ....task.decorator import python_task
+from ....task.any_task import AnyTask
 from ....task.task import Task
-from ....task_input.task_input import Input
+from ....task_input.any_input import AnyInput
 from ....helper.codemod.add_import_module import add_import_module
 from ....helper.codemod.add_assert_resource import add_assert_resource
 from ....helper.file.copy_tree import copy_tree
@@ -13,8 +15,9 @@ import os
 CURRENT_DIR = os.path.dirname(__file__)
 
 
+@typechecked
 def create_ensure_project_tasks(
-    upstreams: Optional[List[Task]] = None
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     '''
     Create a task to ensure there are project tasks under `_automate/_project`
@@ -48,11 +51,12 @@ def create_ensure_project_tasks(
     return _task
 
 
+@typechecked
 def create_add_build_images_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('build_project_images.py'),
@@ -64,11 +68,12 @@ def create_add_build_images_upstream(
     )
 
 
+@typechecked
 def create_add_deploy_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('deploy_project.py'),
@@ -80,11 +85,12 @@ def create_add_deploy_upstream(
     )
 
 
+@typechecked
 def create_add_destroy_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('destroy_project.py'),
@@ -96,11 +102,12 @@ def create_add_destroy_upstream(
     )
 
 
+@typechecked
 def create_add_push_images_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('push_project_images.py'),
@@ -112,11 +119,12 @@ def create_add_push_images_upstream(
     )
 
 
+@typechecked
 def create_add_remove_containers_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('remove_project_containers.py'),
@@ -128,11 +136,12 @@ def create_add_remove_containers_upstream(
     )
 
 
+@typechecked
 def create_add_start_containers_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('start_project_containers.py'),
@@ -144,11 +153,12 @@ def create_add_start_containers_upstream(
     )
 
 
+@typechecked
 def create_add_start_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('start_project.py'),
@@ -160,11 +170,12 @@ def create_add_start_upstream(
     )
 
 
+@typechecked
 def create_add_stop_containers_upstream(
     upstream_module: str,
     upstream_task_var: str,
-    inputs: Optional[List[Input]] = None,
-    upstreams: Optional[List[Task]] = None
+    inputs: Optional[List[AnyInput]] = None,
+    upstreams: Optional[List[AnyTask]] = None
 ) -> Task:
     return create_add_upstream(
         task_file_name=_get_project_task_file('stop_project_containers.py'),
@@ -176,5 +187,6 @@ def create_add_stop_containers_upstream(
     )
 
 
-def _get_project_task_file(task_file_name: str):
+@typechecked
+def _get_project_task_file(task_file_name: str) -> str:
     return os.path.join('_automate', '_project', task_file_name)

zrb/builtin/generator/project_task/template/_automate/_project/build_project_images.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 build_project_images = Task(

zrb/builtin/generator/project_task/template/_automate/_project/deploy_project.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 deploy_project = Task(

zrb/builtin/generator/project_task/template/_automate/_project/destroy_project.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 destroy_project = Task(

zrb/builtin/generator/project_task/template/_automate/_project/push_project_images.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 push_project_images = Task(

zrb/builtin/generator/project_task/template/_automate/_project/remove_project_containers.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 remove_project_containers = Task(

zrb/builtin/generator/project_task/template/_automate/_project/start_project.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 start_project = Task(

zrb/builtin/generator/project_task/template/_automate/_project/start_project_containers.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 start_project_containers = Task(

zrb/builtin/generator/project_task/template/_automate/_project/stop_project_containers.py

@@ -1,4 +1,4 @@
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 from zrb import Task, runner
 
 stop_project_containers = Task(

zrb/builtin/generator/python_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 ....task.decorator import python_task
 from ....task.task import 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
+from ...group import project_add_group
 
 import os
 

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

@@ -1,6 +1,6 @@
 from typing import Any, Mapping
 from zrb import Task, python_task, runner
-from zrb.builtin._group import project_group
+from zrb.builtin.group import project_group
 
 ###############################################################################
 # Task Definitions

zrb/builtin/generator/simple_python_app/add.py

@@ -1,17 +1,12 @@
 from typing import Any
-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 (
+from ..common.helper import (
+    validate_existing_project_dir, validate_inexisting_automation
+)
+from ..common.task_input import (
     project_dir_input, app_name_input, app_image_name_input, http_port_input,
     env_prefix_input
 )
-from .._common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
-)
-from .._common.task_factory import create_register_module
+from ..common.task_factory import create_register_module
 from ..project_task.task_factory import (
     create_ensure_project_tasks, create_add_build_images_upstream,
     create_add_deploy_upstream, create_add_destroy_upstream,
@@ -19,7 +14,12 @@ from ..project_task.task_factory import (
     create_add_start_containers_upstream, create_add_start_upstream,
     create_add_stop_containers_upstream
 )
-from ....helper import util
+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 ....helper.util import to_kebab_case
 
 import os
 
@@ -40,9 +40,7 @@ async def validate(*args: Any, **kwargs: Any):
     validate_existing_project_dir(project_dir)
     app_name = kwargs.get('app_name')
     validate_inexisting_automation(project_dir, app_name)
-    source_dir = os.path.join(
-        project_dir, 'src', f'{util.to_kebab_case(app_name)}'
-    )
+    source_dir = os.path.join(project_dir, 'src', f'{to_kebab_case(app_name)}')
     if os.path.exists(source_dir):
         raise Exception(f'Source already exists: {source_dir}')
 
@@ -103,56 +101,56 @@ ensure_project_tasks = create_ensure_project_tasks(
     upstreams=[copy_resource]
 )
 
-add_start = 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=[app_name_input]
 )
 
-add_start_container = 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=[app_name_input]
 )
 
-add_stop_container = 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=[app_name_input]
 )
 
-add_remove_container = 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=[app_name_input]
 )
 
-add_build_image = 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=[app_name_input]
 )
 
-add_push_image = 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=[app_name_input]
 )
 
-add_deploy = 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=[app_name_input]
 )
 
-add_destroy = 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],
@@ -168,14 +166,14 @@ add_destroy = create_add_destroy_upstream(
         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
 )

zrb/builtin/generator/simple_python_app/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/simple_python_app/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.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/simple_python_app/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/simple_python_app/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

zrb/builtin/git.py

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

zrb/builtin/md5.py

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

zrb/builtin/project.py

@@ -1,5 +1,5 @@
 from typing import Any, Mapping
-from ._group import project_group
+from .group import project_group
 from ..task.decorator import python_task
 from ..task_input.bool_input import BoolInput
 from ..runner import runner

zrb/builtin/ubuntu.py

@@ -1,4 +1,4 @@
-from ._group import ubuntu_group, ubuntu_install_group
+from .group import ubuntu_group, ubuntu_install_group
 from ..task.cmd_task import CmdTask
 from ..runner import runner
 
@@ -43,8 +43,8 @@ install_packages = CmdTask(
         '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 bison libblas-dev liblapack-dev \\',
-        'gfortran rustc fd-find ripgrep wget curl git ncat cmake make tree \\',
-        'tmux zsh neovim xdotool xsel'
+        'golang gfortran rustc fd-find ripgrep wget curl git ncat \\',
+        'cmake make tree tmux zsh neovim xdotool xsel'
     ],
     upstreams=[update_task],
     checking_interval=3,

zrb/config/config.py

@@ -1,18 +1,20 @@
 from ..helper.string.conversion import to_boolean, to_logging_level
+from typeguard import typechecked
 import os
-import pkg_resources
+import importlib.metadata as metadata
 
 
-def get_version():
+@typechecked
+def get_version() -> str:
     try:
-        dist = pkg_resources.get_distribution("zrb")
-        return dist.version
-    except pkg_resources.DistributionNotFound:
+        return metadata.version("zrb")
+    except metadata.PackageNotFoundError:
         import flit
         meta = flit.read_module_metadata("zrb")
-        return meta["module"]["version"]
+        return str(meta["module"]["version"])
 
 
+@typechecked
 def get_current_shell() -> str:
     current_shell = os.getenv('SHELL', '')
     if current_shell.endswith('zsh'):

zrb/helper/accessories/color.py

@@ -1,9 +1,11 @@
 from typing import Iterable, Optional
+from typeguard import typechecked
 from termcolor import colored as term_colored, COLORS
 import random
 
 
-def get_random_color():
+@typechecked
+def get_random_color() -> str:
     colors = [
         'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'light_green',
         'light_yellow', 'light_blue', 'light_magenta', 'light_cyan',
@@ -11,10 +13,12 @@ def get_random_color():
     return random.choice(colors)
 
 
+@typechecked
 def is_valid_color(color: str) -> bool:
     return color in COLORS
 
 
+@typechecked
 def colored(
     text: str,
     color: Optional[str] = None,

zrb/helper/accessories/icon.py

@@ -1,6 +1,8 @@
+from typeguard import typechecked
 import random
 
 
+@typechecked
 def get_random_icon() -> str:
     icons = [
         '🐶', '🐱', '🐭', '🐹', '🦊', '🐻', '🐨', '🐯', '🦁', '🐮', '🐷', '🍎', '🍐',

zrb/helper/accessories/name.py

@@ -1,7 +1,9 @@
+from typeguard import typechecked
 import random
 import string
 
 
+@typechecked
 def get_random_name(
     separator: str = '-',
     add_random_digit: bool = True,

zrb/helper/advertisement.py

@@ -18,6 +18,7 @@ class Advertisement():
         print(colored(self.content, attrs=['dark']), file=sys.stderr)
 
 
+@typechecked
 def get_advertisement(
     advertisements: Iterable[Advertisement]
 ) -> Optional[Advertisement]:

zrb/helper/cli.py

@@ -1,6 +1,7 @@
+from typeguard import typechecked
 from ..runner import runner
-from .loader.load_module import load_module
 from ..config.config import init_scripts, should_load_builtin
+from .loader.load_module import load_module
 from .log import logger
 from .accessories.color import colored
 
@@ -9,6 +10,7 @@ import os
 import sys
 
 
+@typechecked
 def create_cli() -> click.Group:
     cli = click.Group(name='zrb', help='Super framework for your super app.')
     # load from ZRB_INIT_SCRIPTS environment
@@ -31,6 +33,7 @@ def create_cli() -> click.Group:
     return cli
 
 
+@typechecked
 def _load_zrb_init(project_dir: str):
     project_script = os.path.join(project_dir, 'zrb_init.py')
     if not os.path.isfile(project_script):
@@ -43,6 +46,7 @@ def _load_zrb_init(project_dir: str):
     load_module(script_path=project_script)
 
 
+@typechecked
 def _get_new_python_path(project_dir: str) -> str:
     current_python_path = os.getenv('PYTHONPATH')
     if current_python_path is None or current_python_path == '':