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

zrb/builtin/generator/pip_package/add.py

@@ -1,20 +1,25 @@
-from zrb.helper.typing import Any
-from zrb.builtin.generator.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
-)
+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 (
+    package_author_email_input,
+    package_author_name_input,
+    package_bug_tracker_input,
+    package_description_input,
+    package_homepage_input,
+    package_name_input,
+    project_dir_input,
+)
 from zrb.builtin.group import project_add_group
+from zrb.helper.typing import Any
+from zrb.runner import runner
 from zrb.task.decorator import python_task
-from zrb.task.task import Task
 from zrb.task.resource_maker import ResourceMaker
-from zrb.runner import runner
-
-import os
+from zrb.task.task import Task
 
 CURRENT_DIR = os.path.dirname(__file__)
 
@@ -24,22 +29,16 @@ CURRENT_DIR = os.path.dirname(__file__)
 ###############################################################################
 
 
-@python_task(
-    name='validate',
-    inputs=[
-        project_dir_input,
-        package_name_input
-    ]
-)
+@python_task(name="validate", inputs=[project_dir_input, package_name_input])
 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)
-    package_name = kwargs.get('package_name')
+    package_name = kwargs.get("package_name")
     validate_inexisting_automation(project_dir, package_name)
 
 
 copy_resource = ResourceMaker(
-    name='copy-resource',
+    name="copy-resource",
     inputs=[
         project_dir_input,
         package_name_input,
@@ -47,34 +46,34 @@ copy_resource = ResourceMaker(
         package_homepage_input,
         package_bug_tracker_input,
         package_author_name_input,
-        package_author_email_input
+        package_author_email_input,
     ],
     upstreams=[validate],
     replacements={
-        'zrbPackageName': '{{input.package_name}}',
-        'zrbPackageDescription': '{{input.package_description}}',
-        'zrbPackageHomepage': '{{input.package_homepage}}',
-        'zrbPackageBugTracker': '{{input.package_bug_tracker}}',
-        'zrbPackageAuthorName': '{{input.package_author_name}}',
-        'zrbPackageAuthorEmail': '{{input.package_author_email}}'
+        "zrbPackageName": "{{input.package_name}}",
+        "zrbPackageDescription": "{{input.package_description}}",
+        "zrbPackageHomepage": "{{input.package_homepage}}",
+        "zrbPackageBugTracker": "{{input.package_bug_tracker}}",
+        "zrbPackageAuthorName": "{{input.package_author_name}}",
+        "zrbPackageAuthorEmail": "{{input.package_author_email}}",
     },
-    template_path=os.path.join(CURRENT_DIR, 'template'),
-    destination_path='{{ input.project_dir }}',
+    template_path=os.path.join(CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
     excludes=[
-        '*/__pycache__',
-    ]
+        "*/__pycache__",
+    ],
 )
 
 register_module = create_register_module(
-    module_path='_automate.{{util.to_snake_case(input.package_name)}}.local',
-    alias='{{util.to_snake_case(input.package_name)}}_local',
+    module_path="_automate.{{util.to_snake_case(input.package_name)}}.local",
+    alias="{{util.to_snake_case(input.package_name)}}_local",
     inputs=[package_name_input],
-    upstreams=[copy_resource]
+    upstreams=[copy_resource],
 )
 
 
 @python_task(
-    name='pip-package',
+    name="pip-package",
     group=project_add_group,
     upstreams=[register_module],
     inputs=[
@@ -84,10 +83,10 @@ register_module = create_register_module(
         package_homepage_input,
         package_bug_tracker_input,
         package_author_name_input,
-        package_author_email_input
+        package_author_email_input,
     ],
-    runner=runner
+    runner=runner,
 )
 async def add_pip_package(*args: Any, **kwargs: Any):
-    task: Task = kwargs.get('_task')
-    task.print_out('Success')
+    task: Task = kwargs.get("_task")
+    task.print_out("Success")

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

@@ -1,26 +1,26 @@
-from zrb import CmdTask, runner, StrInput
-from zrb.builtin.group import project_group
-
 import os
 
+from zrb import CmdTask, StrInput, runner
+from zrb.builtin.group 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-package-name')
-PACKAGE_DIR = os.path.join(RESOURCE_DIR, 'src')
+PROJECT_DIR = os.path.abspath(os.path.join(CURRENT_DIR, "..", ".."))
+RESOURCE_DIR = os.path.join(PROJECT_DIR, "src", "kebab-zrb-package-name")
+PACKAGE_DIR = os.path.join(RESOURCE_DIR, "src")
 
 ###############################################################################
 # ⚙️ prepare-kebab-zrb-package-name
 ###############################################################################
 
 prepare_snake_zrb_package_name = CmdTask(
-    name='prepare-kebab-zrb-package-name',
-    description='Prepare venv for human readable zrb package name',
+    name="prepare-kebab-zrb-package-name",
+    description="Prepare venv for human readable zrb package name",
     group=project_group,
     cwd=RESOURCE_DIR,
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'activate-venv.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'prepare-venv.sh'),
-    ]
+        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "prepare-venv.sh"),
+    ],
 )
 runner.register(prepare_snake_zrb_package_name)
 
@@ -29,15 +29,15 @@ runner.register(prepare_snake_zrb_package_name)
 ###############################################################################
 
 build_snake_zrb_package_name = CmdTask(
-    name='build-kebab-zrb-package-name',
-    description='Build human readable zrb package name',
+    name="build-kebab-zrb-package-name",
+    description="Build human readable zrb package name",
     group=project_group,
     upstreams=[prepare_snake_zrb_package_name],
     cwd=RESOURCE_DIR,
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'activate-venv.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'build.sh'),
-    ]
+        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "build.sh"),
+    ],
 )
 runner.register(build_snake_zrb_package_name)
 
@@ -46,23 +46,23 @@ runner.register(build_snake_zrb_package_name)
 ###############################################################################
 
 publish_snake_zrb_package_name = CmdTask(
-    name='publish-kebab-zrb-package-name',
-    description='Publish human readable zrb package name',
+    name="publish-kebab-zrb-package-name",
+    description="Publish human readable zrb package name",
     group=project_group,
     inputs=[
         StrInput(
-            name='kebab-zrb-package-name-repo',
-            prompt='Pypi repository for human readable zrb package name',
-            description='Pypi repository for human readalbe zrb package name',
-            default='pypi',
+            name="kebab-zrb-package-name-repo",
+            prompt="Pypi repository for human readable zrb package name",
+            description="Pypi repository for human readalbe zrb package name",
+            default="pypi",
         )
     ],
     upstreams=[build_snake_zrb_package_name],
     cwd=RESOURCE_DIR,
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'activate-venv.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'publish.sh'),
-    ]
+        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "publish.sh"),
+    ],
 )
 runner.register(publish_snake_zrb_package_name)
 
@@ -71,14 +71,14 @@ runner.register(publish_snake_zrb_package_name)
 ###############################################################################
 
 install_snake_zrb_package_name_symlink = CmdTask(
-    name='install-kebab-zrb-package-name-symlink',
-    description='Install human readable zrb package name as symlink',
+    name="install-kebab-zrb-package-name-symlink",
+    description="Install human readable zrb package name as symlink",
     group=project_group,
     upstreams=[build_snake_zrb_package_name],
     cwd=RESOURCE_DIR,
     cmd_path=[
-        os.path.join(CURRENT_DIR, 'cmd', 'activate-venv.sh'),
-        os.path.join(CURRENT_DIR, 'cmd', 'install-symlink.sh'),
-    ]
+        os.path.join(CURRENT_DIR, "cmd", "activate-venv.sh"),
+        os.path.join(CURRENT_DIR, "cmd", "install-symlink.sh"),
+    ],
 )
 runner.register(install_snake_zrb_package_name_symlink)

zrb/builtin/generator/pip_package/template/src/kebab-zrb-package-name/src/snake_zrb_package_name/__init__.py

@@ -1,2 +1,3 @@
 from .util import hello
+
 assert hello

zrb/builtin/generator/pip_package/template/src/kebab-zrb-package-name/src/snake_zrb_package_name/__main__.py

@@ -1,2 +1,3 @@
 from .util import hello
+
 assert hello

zrb/builtin/generator/pip_package/template/src/kebab-zrb-package-name/src/snake_zrb_package_name/util.py

@@ -1,2 +1,2 @@
-def hello(name: str = 'World'):
-    return f'Hello {name}!'
+def hello(name: str = "World"):
+    return f"Hello {name}!"

zrb/builtin/generator/plugin/create.py

@@ -1,25 +1,28 @@
-from zrb.builtin.group import plugin_group
+import os
+
 from zrb.builtin.generator.common.task_input import (
-    project_dir_input, package_description_input,
-    package_homepage_input, package_bug_tracker_input,
-    package_author_name_input, package_author_email_input
+    package_author_email_input,
+    package_author_name_input,
+    package_bug_tracker_input,
+    package_description_input,
+    package_homepage_input,
+    project_dir_input,
 )
-from zrb.task.resource_maker import ResourceMaker
+from zrb.builtin.group import plugin_group
+from zrb.config.config import version
+from zrb.runner import runner
 from zrb.task.cmd_task import CmdTask
+from zrb.task.resource_maker import ResourceMaker
 from zrb.task_input.str_input import StrInput
-from zrb.runner import runner
-from zrb.config.config import version
-
-import os
 
 CURRENT_DIR = os.path.dirname(__file__)
 
 plugin_package_name_input = StrInput(
-    name='package-name',
-    shortcut='p',
-    description='Package name',
-    prompt='Package name',
-    default='{{ input.project_dir }}',
+    name="package-name",
+    shortcut="p",
+    description="Package name",
+    prompt="Package name",
+    default="{{ input.project_dir }}",
 )
 
 
@@ -28,7 +31,7 @@ plugin_package_name_input = StrInput(
 ###############################################################################
 
 copy_resource = ResourceMaker(
-    name='copy-resource',
+    name="copy-resource",
     inputs=[
         project_dir_input,
         plugin_package_name_input,
@@ -36,39 +39,39 @@ copy_resource = ResourceMaker(
         package_homepage_input,
         package_bug_tracker_input,
         package_author_name_input,
-        package_author_email_input
+        package_author_email_input,
     ],
     replacements={
-        'zrbPackageName': '{{input.package_name}}',
-        'zrbPackageDescription': '{{input.package_description}}',
-        'zrbPackageHomepage': '{{input.package_homepage}}',
-        'zrbPackageBugTracker': '{{input.package_bug_tracker}}',
-        'zrbPackageAuthorName': '{{input.package_author_name}}',
-        'zrbPackageAuthorEmail': '{{input.package_author_email}}',
-        'zrbVersion': version
+        "zrbPackageName": "{{input.package_name}}",
+        "zrbPackageDescription": "{{input.package_description}}",
+        "zrbPackageHomepage": "{{input.package_homepage}}",
+        "zrbPackageBugTracker": "{{input.package_bug_tracker}}",
+        "zrbPackageAuthorName": "{{input.package_author_name}}",
+        "zrbPackageAuthorEmail": "{{input.package_author_email}}",
+        "zrbVersion": version,
     },
-    template_path=os.path.join(CURRENT_DIR, 'template'),
-    destination_path='{{ input.project_dir }}',
+    template_path=os.path.join(CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
     excludes=[
-        '*/__pycache__',
-    ]
+        "*/__pycache__",
+    ],
 )
 
 create = CmdTask(
-    name='create',
-    description='Create plugin',
+    name="create",
+    description="Create plugin",
     group=plugin_group,
     upstreams=[copy_resource],
     inputs=[project_dir_input],
     cmd=[
-        'set -e',
+        "set -e",
         'cd "{{input.project_dir}}"',
-        'if [ ! -d .git ]',
-        'then',
-        '  echo Initialize project git repository',
-        '  git init',
-        'fi',
+        "if [ ! -d .git ]",
+        "then",
+        "  echo Initialize project git repository",
+        "  git init",
+        "fi",
         'echo "Happy coding :)"',
-    ]
+    ],
 )
 runner.register(create)

zrb/builtin/generator/plugin/template/src/snake_zrb_package_name/__init__.py

@@ -2,6 +2,6 @@ from .task.example_task import ExampleTask
 
 
 def main():
-    task = ExampleTask(name='main')
+    task = ExampleTask(name="main")
     fn = task.to_function()
     fn()

zrb/builtin/generator/plugin/template/src/snake_zrb_package_name/__main__.py

@@ -1,2 +1,3 @@
 from .task.example_task import ExampleTask
+
 assert ExampleTask

zrb/builtin/generator/plugin/template/src/snake_zrb_package_name/task/example_task.py

@@ -1,14 +1,16 @@
 from typing import Any
+
 from zrb import Task
 
-HELLO_WORLD = '👋🌍'
+HELLO_WORLD = "👋🌍"
 
 
 class ExampleTask(Task):
-    '''
+    """
     ExampleTask, write "Hello World" in emoji.
-    '''
+    """
+
     async def run(self, *args: Any, **kwargs: Any) -> Any:
-        task: Task = kwargs.get('_task')
+        task: Task = kwargs.get("_task")
         task.print_out(HELLO_WORLD)
         return HELLO_WORLD

zrb/builtin/generator/plugin/template/zrb_init.py

@@ -1,8 +1,8 @@
-from zrb import CmdTask, runner, StrInput
-from zrb.builtin.group import plugin_group
-
 import os
 
+from zrb import CmdTask, StrInput, runner
+from zrb.builtin.group import plugin_group
+
 PROJECT_DIR = os.path.dirname(__file__)
 
 ###############################################################################
@@ -10,14 +10,14 @@ PROJECT_DIR = os.path.dirname(__file__)
 ###############################################################################
 
 prepare_plugin = CmdTask(
-    name='prepare',
+    name="prepare",
     group=plugin_group,
-    description='Prepare venv for plugin',
+    description="Prepare venv for plugin",
     cwd=PROJECT_DIR,
     cmd_path=[
-        os.path.join(PROJECT_DIR, '_cmd', 'activate-venv.sh'),
-        os.path.join(PROJECT_DIR, '_cmd', 'prepare-venv.sh'),
-    ]
+        os.path.join(PROJECT_DIR, "_cmd", "activate-venv.sh"),
+        os.path.join(PROJECT_DIR, "_cmd", "prepare-venv.sh"),
+    ],
 )
 runner.register(prepare_plugin)
 
@@ -26,15 +26,15 @@ runner.register(prepare_plugin)
 ###############################################################################
 
 build_plugin = CmdTask(
-    name='build',
+    name="build",
     group=plugin_group,
-    description='Build plugin',
+    description="Build plugin",
     upstreams=[prepare_plugin],
     cwd=PROJECT_DIR,
     cmd_path=[
-        os.path.join(PROJECT_DIR, '_cmd', 'activate-venv.sh'),
-        os.path.join(PROJECT_DIR, '_cmd', 'build.sh'),
-    ]
+        os.path.join(PROJECT_DIR, "_cmd", "activate-venv.sh"),
+        os.path.join(PROJECT_DIR, "_cmd", "build.sh"),
+    ],
 )
 runner.register(build_plugin)
 
@@ -43,23 +43,23 @@ runner.register(build_plugin)
 ###############################################################################
 
 publish_plugin = CmdTask(
-    name='publish',
+    name="publish",
     group=plugin_group,
-    description='Publish plugin',
+    description="Publish plugin",
     inputs=[
         StrInput(
-            name='plugin-repo',
-            prompt='Pypi repository for plugin',
-            description='Pypi repository for human readalbe zrb package name',
-            default='pypi',
+            name="plugin-repo",
+            prompt="Pypi repository for plugin",
+            description="Pypi repository for human readalbe zrb package name",
+            default="pypi",
         )
     ],
     upstreams=[build_plugin],
     cwd=PROJECT_DIR,
     cmd_path=[
-        os.path.join(PROJECT_DIR, '_cmd', 'activate-venv.sh'),
-        os.path.join(PROJECT_DIR, '_cmd', 'publish.sh'),
-    ]
+        os.path.join(PROJECT_DIR, "_cmd", "activate-venv.sh"),
+        os.path.join(PROJECT_DIR, "_cmd", "publish.sh"),
+    ],
 )
 runner.register(publish_plugin)
 
@@ -68,14 +68,14 @@ runner.register(publish_plugin)
 ###############################################################################
 
 install_plugin_symlink = CmdTask(
-    name='install-symlink',
+    name="install-symlink",
     group=plugin_group,
-    description='Install plugin as symlink',
+    description="Install plugin as symlink",
     upstreams=[build_plugin],
     cwd=PROJECT_DIR,
     cmd_path=[
-        os.path.join(PROJECT_DIR, '_cmd', 'activate-venv.sh'),
-        os.path.join(PROJECT_DIR, '_cmd', 'install-symlink.sh'),
-    ]
+        os.path.join(PROJECT_DIR, "_cmd", "activate-venv.sh"),
+        os.path.join(PROJECT_DIR, "_cmd", "install-symlink.sh"),
+    ],
 )
 runner.register(install_plugin_symlink)

zrb/builtin/generator/project/create.py

@@ -1,24 +1,23 @@
-from zrb.helper.typing import Any, Mapping
-from zrb.helper.typecheck import typechecked
+import os
+
 from zrb.builtin.generator.common.task_input import (
-    project_dir_input, project_name_input
-)
-from zrb.builtin.generator.project_task.task_factory import (
-    create_ensure_project_tasks
+    project_dir_input,
+    project_name_input,
 )
+from zrb.builtin.generator.project_task.task_factory import create_ensure_project_tasks
 from zrb.builtin.group import project_group
+from zrb.config.config import version
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import Any, Mapping
+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.runner import runner
-from zrb.config.config import version
-
-import os
 
 CURRENT_DIR = os.path.dirname(__file__)
-SYSTEM_USER = os.getenv('USER', 'incognito')
+SYSTEM_USER = os.getenv("USER", "incognito")
 IMAGE_DEFAULT_NAMESPACE = os.getenv(
-    'PROJECT_IMAGE_DEFAULT_NAMESPACE', 'docker.io/' + SYSTEM_USER
+    "PROJECT_IMAGE_DEFAULT_NAMESPACE", "docker.io/" + SYSTEM_USER
 )
 
 ###############################################################################
@@ -30,13 +29,11 @@ IMAGE_DEFAULT_NAMESPACE = os.getenv(
 def copy_resource_replacement_mutator(
     task: ResourceMaker, replacements: Mapping[str, str]
 ) -> Mapping[str, str]:
-    replacements['zrbBaseProjectDir'] = os.path.basename(
-        replacements.get('zrbProjectDir', '')
+    replacements["zrbBaseProjectDir"] = os.path.basename(
+        replacements.get("zrbProjectDir", "")
     )
-    if replacements.get('zrbProjectName', '') == '':
-        replacements['zrbProjectName'] = replacements.get(
-            'zrbBaseProjectDir', ''
-        )
+    if replacements.get("zrbProjectName", "") == "":
+        replacements["zrbProjectName"] = replacements.get("zrbBaseProjectDir", "")
     return replacements
 
 
@@ -46,55 +43,50 @@ def copy_resource_replacement_mutator(
 
 
 @python_task(
-    name='validate',
+    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}')
+    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
-    ],
+    name="copy-resource",
+    inputs=[project_dir_input, project_name_input],
     upstreams=[validate],
     replacements={
-        'zrbProjectDir': '{{input.project_dir}}',
-        'zrbProjectName': '{{input.project_name}}',
-        'zrbImageDefaultNamespace': IMAGE_DEFAULT_NAMESPACE,
-        'zrbVersion': version,
+        "zrbProjectDir": "{{input.project_dir}}",
+        "zrbProjectName": "{{input.project_name}}",
+        "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}}',
+    template_path=os.path.join(CURRENT_DIR, "template"),
+    destination_path="{{input.project_dir}}",
     excludes=[
-        '*/__pycache__',
-    ]
+        "*/__pycache__",
+    ],
 )
 
-ensure_project_tasks = create_ensure_project_tasks(
-    upstreams=[copy_resource]
-)
+ensure_project_tasks = create_ensure_project_tasks(upstreams=[copy_resource])
 
 create_project = CmdTask(
-    name='create',
+    name="create",
     group=project_group,
     upstreams=[ensure_project_tasks],
     inputs=[project_dir_input],
     cmd=[
-        'set -e',
+        "set -e",
         'cd "{{input.project_dir}}"',
-        'if [ ! -d .git ]',
-        'then',
-        '  echo Initialize project git repository',
-        '  git init',
-        'fi',
+        "if [ ! -d .git ]",
+        "then",
+        "  echo Initialize project git repository",
+        "  git init",
+        "fi",
         'echo "Happy coding :)"',
-    ]
+    ],
 )
 runner.register(create_project)

zrb/builtin/generator/project/template/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E704