zrb 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

zrb/builtin/env.py

@@ -1,9 +1,9 @@
-from zrb.helper.typing import Any, List
 from zrb.builtin.group import env_group
 from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any, List
+from zrb.runner import runner
 from zrb.task.decorator import python_task
 from zrb.task.task import Task
-from zrb.runner import runner
 
 ###############################################################################
 # Task Definitions
@@ -11,23 +11,20 @@ from zrb.runner import runner
 
 
 @python_task(
-    name='get',
-    group=env_group,
-    description='Get environment values',
-    runner=runner
+    name="get", group=env_group, description="Get environment values", runner=runner
 )
 async def get(*args: Any, **kwargs: Any):
-    task: Task = kwargs['_task']
+    task: Task = kwargs["_task"]
     env_map = task.get_env_map()
     names = list(env_map.keys())
     names.sort()
-    colored_equal = colored('=', color='grey', attrs=['dark'])
+    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'])
-        env_lines.append(f'{colored_name}{colored_equal}{colored_value}')
-    line_separator = '\n    '
+        colored_name = colored(name, color="green", attrs=["bold"])
+        colored_value = colored(value, attrs=["bold"])
+        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/eval.py

@@ -1,7 +1,7 @@
 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
-from zrb.runner import runner
 
 ###############################################################################
 # Task Definitions
@@ -9,19 +9,19 @@ from zrb.runner import runner
 
 
 @python_task(
-    name='eval',
+    name="eval",
     inputs=[
         StrInput(
-            name='expression',
-            shortcut='e',
-            default='',
-            description='Python expression',
+            name="expression",
+            shortcut="e",
+            default="",
+            description="Python expression",
         )
     ],
-    description='Evaluate Python expression',
+    description="Evaluate Python expression",
     retry=0,
-    runner=runner
+    runner=runner,
 )
 async def evaluate(*args: str, **kwargs: Any):
-    expression: str = kwargs.get('expression', '')
+    expression: str = kwargs.get("expression", "")
     return eval(expression)

zrb/builtin/explain.py

@@ -1,9 +1,8 @@
-from zrb.helper.typing import Any
-from zrb.helper.python_task import show_lines
 from zrb.builtin.group import explain_group
-from zrb.task.decorator import python_task
+from zrb.helper.python_task import show_lines
+from zrb.helper.typing import Any
 from zrb.runner import runner
-
+from zrb.task.decorator import python_task
 
 ###############################################################################
 # Task Definitions
@@ -11,110 +10,110 @@ from zrb.runner import runner
 
 
 @python_task(
-    name='solid-principle',
+    name="solid-principle",
     group=explain_group,
-    description='Explain SOLID principle',
-    runner=runner
+    description="Explain SOLID principle",
+    runner=runner,
 )
 async def explain_solid_principle(*args: Any, **kwargs: Any):
     show_lines(
-        kwargs['_task'],
-        'S - Single Responsibility Principle',
-        'O - Open/Closed Principle',
-        'L - Liskov’s Substitution Principle',
-        'I - Interface Segregation Principle',
-        'D - Dependency Inversion Principle',
-        '',
-        'In software development, Object-Oriented Design plays a crucial role when it comes to writing flexible, scalable, maintainable, and reusable code. There are so many benefits of using OOD but every developer should also have the knowledge of the SOLID principle for good object-oriented design in programming. The SOLID principle was introduced by Robert C. Martin, also known as Uncle Bob and it is a coding standard in programming.', # noqa
-        '',
-        'The SOLID principle helps in reducing tight coupling. Tight coupling means a group of classes are highly dependent on one another which you should avoid in your code. Opposite of tight coupling is loose coupling and your code is considered as a good code when it has loosely-coupled classes. Loosely coupled classes minimize changes in your code, helps in making code more reusable, maintainable, flexible and stable.', # noqa
+        kwargs["_task"],
+        "S - Single Responsibility Principle",
+        "O - Open/Closed Principle",
+        "L - Liskov’s Substitution Principle",
+        "I - Interface Segregation Principle",
+        "D - Dependency Inversion Principle",
+        "",
+        "In software development, Object-Oriented Design plays a crucial role when it comes to writing flexible, scalable, maintainable, and reusable code. There are so many benefits of using OOD but every developer should also have the knowledge of the SOLID principle for good object-oriented design in programming. The SOLID principle was introduced by Robert C. Martin, also known as Uncle Bob and it is a coding standard in programming.",  # noqa
+        "",
+        "The SOLID principle helps in reducing tight coupling. Tight coupling means a group of classes are highly dependent on one another which you should avoid in your code. Opposite of tight coupling is loose coupling and your code is considered as a good code when it has loosely-coupled classes. Loosely coupled classes minimize changes in your code, helps in making code more reusable, maintainable, flexible and stable.",  # noqa
     )
 
 
 @python_task(
-    name='yagni-principle',
+    name="yagni-principle",
     group=explain_group,
-    description='Explain YAGNI principle',
-    runner=runner
+    description="Explain YAGNI principle",
+    runner=runner,
 )
 async def explain_yagni_principle(*args: Any, **kwargs: Any):
     show_lines(
-        kwargs['_task'],
-        'Y - You',
-        'A - Aren\'t',
-        'G - Gonna',
-        'N - Need',
-        'I - It',
-        '',
-        'YAGNI principle ("You Aren\'t Gonna Need It") is a practice in software development which states that features should only be added when required.', # noqa
-        '',
-        'As a part of the extreme programming (XP) philosophy, YAGNI trims away excess and inefficiency in development to facilitate the desired increased frequency of releases.', # noqa
+        kwargs["_task"],
+        "Y - You",
+        "A - Aren't",
+        "G - Gonna",
+        "N - Need",
+        "I - It",
+        "",
+        'YAGNI principle ("You Aren\'t Gonna Need It") is a practice in software development which states that features should only be added when required.',  # noqa
+        "",
+        "As a part of the extreme programming (XP) philosophy, YAGNI trims away excess and inefficiency in development to facilitate the desired increased frequency of releases.",  # noqa
     )
 
 
 @python_task(
-    name='dry-principle',
+    name="dry-principle",
     group=explain_group,
-    description='Explain DRY principle',
-    runner=runner
+    description="Explain DRY principle",
+    runner=runner,
 )
 async def explain_dry_principle(*args: Any, **kwargs: Any):
     show_lines(
-        kwargs['_task'],
-        'D - Don\'t',
-        'R - Repeat',
-        'Y - Yourself',
-        '',
-        '"Don\'t repeat yourself" (DRY) is a principle of software development aimed at reducing repetition of information which is likely to change, replacing it with abstractions that are less likely to change, or using data normalization which avoids redundancy in the first place.', # noqa
-        '',
-        'The DRY principle is stated as "Every piece of knowledge must have a single, unambiguous, authoritative representation within a system". The principle has been formulated by Andy Hunt and Dave Thomas in their book The Pragmatic Programmer.', # noqa
+        kwargs["_task"],
+        "D - Don't",
+        "R - Repeat",
+        "Y - Yourself",
+        "",
+        '"Don\'t repeat yourself" (DRY) is a principle of software development aimed at reducing repetition of information which is likely to change, replacing it with abstractions that are less likely to change, or using data normalization which avoids redundancy in the first place.',  # noqa
+        "",
+        'The DRY principle is stated as "Every piece of knowledge must have a single, unambiguous, authoritative representation within a system". The principle has been formulated by Andy Hunt and Dave Thomas in their book The Pragmatic Programmer.',  # noqa
     )
 
 
 @python_task(
-    name='kiss-principle',
+    name="kiss-principle",
     group=explain_group,
-    description='Explain KISS principle',
-    runner=runner
+    description="Explain KISS principle",
+    runner=runner,
 )
 async def explain_kiss_principle(*args: Any, **kwargs: Any):
     show_lines(
-        kwargs['_task'],
-        'K - Keep',
-        'I - It',
-        'S - Simple',
-        'S - Stupid',
-        '',
-        'KISS, an acronym for "Keep it simple, stupid!", is a design principle noted by the U.S. Navy in 1960. First seen partly in American English by at least 1938, the KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.' # noqa
+        kwargs["_task"],
+        "K - Keep",
+        "I - It",
+        "S - Simple",
+        "S - Stupid",
+        "",
+        'KISS, an acronym for "Keep it simple, stupid!", is a design principle noted by the U.S. Navy in 1960. First seen partly in American English by at least 1938, the KISS principle states that most systems work best if they are kept simple rather than made complicated; therefore, simplicity should be a key goal in design, and unnecessary complexity should be avoided.',  # noqa
     )
 
 
 @python_task(
-    name='zen-of-python',
+    name="zen-of-python",
     group=explain_group,
-    description='Explain Zen of Python',
-    runner=runner
+    description="Explain Zen of Python",
+    runner=runner,
 )
 async def explain_zen_of_python(*args: Any, **kwargs: Any):
     show_lines(
-        kwargs['_task'],
-        'Beautiful is better than ugly.',
-        'Explicit is better than implicit.',
-        'Simple is better than complex.',
-        'Complex is better than complicated.',
-        'Flat is better than nested.',
-        'Sparse is better than dense.',
-        'Readability counts.',
-        'Special cases aren\'t special enough to break the rules.',
-        'Although practicality beats purity.',
-        'Errors should never pass silently.',
-        'Unless explicitly silenced.',
-        'In the face of ambiguity, refuse the temptation to guess.',
-        'There should be one-- and preferably only one --obvious way to do it.', # noqa
-        'Although that way may not be obvious at first unless you\'re Dutch.',
-        'Now is better than never.',
-        'Although never is often better than *right* now.',
-        'If the implementation is hard to explain, it\'s a bad idea.',
-        'If the implementation is easy to explain, it may be a good idea.',
-        'Namespaces are one honking great idea -- let\'s do more of those!',
+        kwargs["_task"],
+        "Beautiful is better than ugly.",
+        "Explicit is better than implicit.",
+        "Simple is better than complex.",
+        "Complex is better than complicated.",
+        "Flat is better than nested.",
+        "Sparse is better than dense.",
+        "Readability counts.",
+        "Special cases aren't special enough to break the rules.",
+        "Although practicality beats purity.",
+        "Errors should never pass silently.",
+        "Unless explicitly silenced.",
+        "In the face of ambiguity, refuse the temptation to guess.",
+        "There should be one-- and preferably only one --obvious way to do it.",  # noqa
+        "Although that way may not be obvious at first unless you're Dutch.",
+        "Now is better than never.",
+        "Although never is often better than *right* now.",
+        "If the implementation is hard to explain, it's a bad idea.",
+        "If the implementation is easy to explain, it may be a good idea.",
+        "Namespaces are one honking great idea -- let's do more of those!",
     )

zrb/builtin/generator/__init__.py

@@ -1,19 +1,15 @@
-from zrb.builtin.generator.project.create import create_project
-from zrb.builtin.generator.plugin import create as create_plugin
+from zrb.builtin.generator.app_generator import add as add_app_generator
 from zrb.builtin.generator.cmd_task.add import add_cmd_task
-from zrb.builtin.generator.docker_compose_task.add import (
-    add_docker_compose_task
-)
-from zrb.builtin.generator.python_task.add import add_python_task
-from zrb.builtin.generator.simple_python_app import (
-    add as add_simple_python_app
-)
+from zrb.builtin.generator.docker_compose_task.add import add_docker_compose_task
 from zrb.builtin.generator.fastapp import add as add_fastapp
-from zrb.builtin.generator.fastapp_module import add as add_fastapp_module
 from zrb.builtin.generator.fastapp_crud import add as add_fastapp_crud
 from zrb.builtin.generator.fastapp_field import add as add_fastapp_field
+from zrb.builtin.generator.fastapp_module import add as add_fastapp_module
 from zrb.builtin.generator.pip_package import add as add_pip_package
-from zrb.builtin.generator.app_generator import add as add_app_generator
+from zrb.builtin.generator.plugin import create as create_plugin
+from zrb.builtin.generator.project.create import create_project
+from zrb.builtin.generator.python_task.add import add_python_task
+from zrb.builtin.generator.simple_python_app import add as add_simple_python_app
 
 assert create_project
 assert create_plugin

zrb/builtin/generator/app_generator/add.py

@@ -1,21 +1,22 @@
-from zrb.helper.typing import Any
-from zrb.builtin.generator.common.task_input import project_dir_input
+import os
+
 from zrb.builtin.generator.common.helper import (
-    validate_existing_project_dir, validate_inexisting_automation
+    validate_existing_project_dir,
+    validate_inexisting_automation,
 )
 from zrb.builtin.generator.common.task_factory import create_register_module
+from zrb.builtin.generator.common.task_input import project_dir_input
 from zrb.builtin.group import project_add_group
-from zrb.task.decorator import python_task
-from zrb.task.task import Task
+from zrb.helper.accessories.name import get_random_name
+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
+from zrb.task_input.bool_input import BoolInput
 from zrb.task_input.int_input import IntInput
 from zrb.task_input.str_input import StrInput
-from zrb.task_input.bool_input import BoolInput
-from zrb.helper.accessories.name import get_random_name
-from zrb.runner import runner
-
-import os
 
 CURRENT_DIR = os.path.dirname(__file__)
 
@@ -24,55 +25,55 @@ CURRENT_DIR = os.path.dirname(__file__)
 ###############################################################################
 
 template_name_input = StrInput(
-    name='template-name',
-    shortcut='t',
-    description='Template name',
-    prompt='Template name',
-    default=get_random_name()
+    name="template-name",
+    shortcut="t",
+    description="Template name",
+    prompt="Template name",
+    default=get_random_name(),
 )
 
 base_image_input = StrInput(
-    name='base-image',
-    shortcut='i',
-    description='Base image',
-    prompt='Base image',
-    default='stalchmst/moku:1.0.0'
+    name="base-image",
+    shortcut="i",
+    description="Base image",
+    prompt="Base image",
+    default="stalchmst/moku:1.0.0",
 )
 
 default_app_port_input = IntInput(
-    name='default-app-port',
-    shortcut='p',
-    description='Default app port',
-    prompt='Default app port',
-    default='8080'
+    name="default-app-port",
+    shortcut="p",
+    description="Default app port",
+    prompt="Default app port",
+    default="8080",
 )
 
 build_custom_image_input = BoolInput(
-    name='build-custom-image',
-    description='Whether build custom image or not',
-    prompt='Does user need to create custom image?',
-    default=True
+    name="build-custom-image",
+    description="Whether build custom image or not",
+    prompt="Does user need to create custom image?",
+    default=True,
 )
 
 is_container_only_input = BoolInput(
-    name='is-container-only',
-    description='Whether app only run as container or not',
-    prompt='Is this container only?',
-    default=False
+    name="is-container-only",
+    description="Whether app only run as container or not",
+    prompt="Is this container only?",
+    default=False,
 )
 
 is_http_port_input = BoolInput(
-    name='is-http-port',
-    description='Whether app run on top of HTTP(s) protocol or not',
-    prompt='Is this a web appp (run on top of HTTP(s))?',
-    default=False
+    name="is-http-port",
+    description="Whether app run on top of HTTP(s) protocol or not",
+    prompt="Is this a web appp (run on top of HTTP(s))?",
+    default=False,
 )
 
 use_helm_input = BoolInput(
-    name='use-helm',
-    description='Whether using helm for deployment or not',
-    prompt='Do you want to use helm for deployment?',
-    default=False
+    name="use-helm",
+    description="Whether using helm for deployment or not",
+    prompt="Do you want to use helm for deployment?",
+    default=False,
 )
 
 ###############################################################################
@@ -91,9 +92,9 @@ inputs = [
 ]
 
 replacements = {
-    'zrbMetaTemplateName': '{{input.template_name}}',
-    'zrbMetaBaseImage': '{{input.base_image}}',
-    'zrbMetaDefaultAppPort': '{{input.default_app_port}}',
+    "zrbMetaTemplateName": "{{input.template_name}}",
+    "zrbMetaBaseImage": "{{input.base_image}}",
+    "zrbMetaDefaultAppPort": "{{input.default_app_port}}",
 }
 
 ###############################################################################
@@ -101,101 +102,99 @@ replacements = {
 ###############################################################################
 
 
-@python_task(
-    name='validate',
-    inputs=inputs,
-    retry=0
-)
+@python_task(name="validate", inputs=inputs, retry=0)
 async def validate(*args: Any, **kwargs: Any):
-    project_dir = kwargs.get('project_dir')
+    project_dir = kwargs.get("project_dir")
     validate_existing_project_dir(project_dir)
-    template_name = kwargs.get('template_name')
+    template_name = kwargs.get("template_name")
     validate_inexisting_automation(project_dir, template_name)
-    is_container_only_input: bool = kwargs.get('is_container_only')
-    build_custom_image_input: bool = kwargs.get('build_custom_image')
+    is_container_only_input: bool = kwargs.get("is_container_only")
+    build_custom_image_input: bool = kwargs.get("build_custom_image")
     if not is_container_only_input and not build_custom_image_input:
         raise Exception(
-            'Invalid options: Not is-container-only but not build-custom-image'
+            "Invalid options: Not is-container-only but not build-custom-image"
         )
 
 
 copy_base_resource = ResourceMaker(
-    name='copy-base-resource',
+    name="copy-base-resource",
     inputs=inputs,
     upstreams=[validate],
     replacements=replacements,
-    template_path=os.path.join(CURRENT_DIR, 'template', 'base'),
-    destination_path='{{ input.project_dir }}',
-    excludes=['*/__pycache__']
+    template_path=os.path.join(CURRENT_DIR, "template", "base"),
+    destination_path="{{ input.project_dir }}",
+    excludes=["*/__pycache__"],
 )
 
 copy_http_port_resource = ResourceMaker(
-    name='copy-http-port-resource',
+    name="copy-http-port-resource",
     inputs=inputs,
-    should_execute='{{ input.is_http_port }}',
+    should_execute="{{ input.is_http_port }}",
     upstreams=[copy_base_resource],
     replacements=replacements,
-    template_path=os.path.join(CURRENT_DIR, 'template', 'http-port'),
-    destination_path='{{ input.project_dir }}',
-    excludes=['*/__pycache__']
+    template_path=os.path.join(CURRENT_DIR, "template", "http-port"),
+    destination_path="{{ input.project_dir }}",
+    excludes=["*/__pycache__"],
 )
 
 copy_custom_image_resource = ResourceMaker(
-    name='copy-custom-image-resource',
+    name="copy-custom-image-resource",
     inputs=inputs,
-    should_execute='{{ input.build_custom_image }}',
+    should_execute="{{ input.build_custom_image }}",
     upstreams=[copy_http_port_resource],
     replacements=replacements,
-    template_path=os.path.join(CURRENT_DIR, 'template', 'build-custom-image'),
-    destination_path='{{ input.project_dir }}',
-    excludes=['*/__pycache__']
+    template_path=os.path.join(CURRENT_DIR, "template", "build-custom-image"),
+    destination_path="{{ input.project_dir }}",
+    excludes=["*/__pycache__"],
 )
 
 copy_http_port_custom_image_resource = ResourceMaker(
-    name='copy-http-port-custom-image-resource',
+    name="copy-http-port-custom-image-resource",
     inputs=inputs,
-    should_execute='{{ input.is_http_port and input.build_custom_image }}',
+    should_execute="{{ input.is_http_port and input.build_custom_image }}",
     upstreams=[copy_custom_image_resource],
     replacements=replacements,
-    template_path=os.path.join(CURRENT_DIR, 'template', 'http-port-build-custom-image'),  # noqa
-    destination_path='{{ input.project_dir }}',
-    excludes=['*/__pycache__']
+    template_path=os.path.join(
+        CURRENT_DIR, "template", "http-port-build-custom-image"
+    ),  # noqa
+    destination_path="{{ input.project_dir }}",
+    excludes=["*/__pycache__"],
 )
 
 copy_helm_resource = ResourceMaker(
-    name='copy-helm-resource',
+    name="copy-helm-resource",
     inputs=inputs,
-    should_execute='{{ input.use_helm }}',
+    should_execute="{{ input.use_helm }}",
     upstreams=[copy_http_port_custom_image_resource],
     replacements=replacements,
-    template_path=os.path.join(CURRENT_DIR, 'template', 'use-helm'),
-    destination_path='{{ input.project_dir }}',
-    excludes=['*/__pycache__']
+    template_path=os.path.join(CURRENT_DIR, "template", "use-helm"),
+    destination_path="{{ input.project_dir }}",
+    excludes=["*/__pycache__"],
 )
 
 copy_resource = CmdTask(
-    name='copy-resource',
+    name="copy-resource",
     upstreams=[
         copy_helm_resource,
     ],
-    cmd='echo Resource copied',
+    cmd="echo Resource copied",
 )
 
 register_module = create_register_module(
-    module_path='_automate.generate_{{util.to_snake_case(input.template_name)}}.add',  # noqa
-    alias='generate_{{util.to_snake_case(input.template_name)}}',
+    module_path="_automate.generate_{{util.to_snake_case(input.template_name)}}.add",  # noqa
+    alias="generate_{{util.to_snake_case(input.template_name)}}",
     inputs=[template_name_input],
-    upstreams=[copy_resource]
+    upstreams=[copy_resource],
 )
 
 
 @python_task(
-    name='app-generator',
+    name="app-generator",
     group=project_add_group,
     upstreams=[register_module],
     inputs=inputs,
-    runner=runner
+    runner=runner,
 )
 async def add_app_generator(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get('_task')
-    task.print_out('Success')
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")