zrb 1.0.0a2__py3-none-any.whl → 1.0.0a3__py3-none-any.whl

zrb/builtin/todo.py

@@ -0,0 +1,186 @@
+import datetime
+import os
+
+from zrb.builtin.group import todo_group
+from zrb.config import TODO_DIR
+from zrb.context.any_context import AnyContext
+from zrb.input.str_input import StrInput
+from zrb.input.text_input import TextInput
+from zrb.task.make_task import make_task
+from zrb.util.cli.style import (
+    stylize_bold_green,
+    stylize_cyan,
+    stylize_magenta,
+    stylize_yellow,
+)
+from zrb.util.string.name import get_random_name
+from zrb.util.todo import (
+    TodoTask,
+    parse_todo_line,
+    read_todo_from_file,
+    todo_task_to_line,
+    write_todo_to_file,
+)
+
+
+@make_task(
+    name="todo-add",
+    input=[
+        StrInput(
+            name="description",
+            description="Task description",
+            prompt="Task description",
+        ),
+        StrInput(
+            name="priority",
+            description="Task priority",
+            prompt="Task priority",
+            default_str="E",
+        ),
+        StrInput(
+            name="project",
+            description="Task project",
+            prompt="Task project (space separated)",
+        ),
+        StrInput(
+            name="context",
+            description="Task context",
+            prompt="Task context (space separated)",
+        ),
+    ],
+    description="➕ Add todo",
+    group=todo_group,
+    alias="add",
+)
+def todo_add(ctx: AnyContext):
+    todo_file_path = os.path.join(TODO_DIR, "todo.txt")
+    todo_tasks: list[TodoTask] = []
+    if os.path.isfile(todo_file_path):
+        todo_tasks = read_todo_from_file(todo_file_path)
+    else:
+        os.makedirs(TODO_DIR, exist_ok=True)
+    todo_tasks.append(
+        _complete_todo_task(
+            TodoTask(
+                priority=ctx.input.priority.upper(),
+                description=ctx.input.description,
+                contexts=[
+                    context.strip()
+                    for context in ctx.input.context.split(" ")
+                    if context.strip() != ""
+                ],
+                projects=[
+                    project.strip()
+                    for project in ctx.input.project.split(" ")
+                    if project.strip() != ""
+                ],
+            )
+        )
+    )
+    write_todo_to_file(todo_file_path, todo_tasks)
+    return _get_visual_todo_list()
+
+
+@make_task(name="todo-list", description="📋 List todo", group=todo_group, alias="list")
+def todo_list(ctx: AnyContext):
+    return _get_visual_todo_list()
+
+
+@make_task(
+    name="todo-edit",
+    input=[
+        TextInput(
+            name="text",
+            description="Todo.txt content",
+            prompt="Todo.txt content (will override existing)",
+            default_str=lambda _: _get_todo_txt_content(),
+        ),
+    ],
+    description="✏️ Edit todo",
+    group=todo_group,
+    alias="edit",
+)
+def todo_edit(ctx: AnyContext):
+    todo_tasks = [
+        _complete_todo_task(parse_todo_line(line))
+        for line in ctx.input.text.split("\n")
+        if line.strip() != ""
+    ]
+    new_content = "\n".join(todo_task_to_line(todo_task) for todo_task in todo_tasks)
+    todo_file_path = os.path.join(TODO_DIR, "todo.txt")
+    with open(todo_file_path, "w") as f:
+        f.write(new_content)
+    return _get_visual_todo_list()
+
+
+def _complete_todo_task(todo_task: TodoTask):
+    if todo_task.creation_date is None:
+        todo_task.creation_date = datetime.date.today()
+    if "id" not in todo_task.keyval:
+        todo_task.keyval["id"] = get_random_name()
+    return todo_task
+
+
+def _get_visual_todo_list() -> str:
+    todo_file_path = os.path.join(TODO_DIR, "todo.txt")
+    if not os.path.isfile(todo_file_path):
+        return "\n".join(["", "  Todo.txt not found... 🌵🦖", ""])
+    todo_tasks = read_todo_from_file(todo_file_path)
+    if len(todo_tasks) == 0:
+        return "\n".join(["", "  Empty todo list... 🌵🦖", ""])
+    max_desc_name_length = max(len(todo_task.description) for todo_task in todo_tasks)
+    if max_desc_name_length < len("DESCRIPTION"):
+        max_desc_name_length = len("DESCRIPTION")
+    # Headers
+    results = [
+        stylize_bold_green(
+            "  ".join(
+                [
+                    "".ljust(3),  # priority
+                    "".ljust(3),  # completed
+                    "COMPLETED AT".rjust(14),  # completed date
+                    "CREATED AT".rjust(14),  # completed date
+                    "DESCRIPTION".ljust(max_desc_name_length),
+                    "PROJECT/CONTEXT/OTHERS",
+                ]
+            )
+        )
+    ]
+    for todo_task in todo_tasks:
+        completed = "[x]" if todo_task.completed else "[ ]"
+        priority = "   " if todo_task.priority is None else f"({todo_task.priority})"
+        completion_date = stylize_yellow(_date_to_str(todo_task.completion_date))
+        creation_date = stylize_cyan(_date_to_str(todo_task.creation_date))
+        description = todo_task.description.ljust(max_desc_name_length)
+        additions = ", ".join(
+            [stylize_yellow(f"+{project}") for project in todo_task.projects]
+            + [stylize_cyan(f"@{context}") for context in todo_task.contexts]
+            + [stylize_magenta(f"{key}:{val}") for key, val in todo_task.keyval.items()]
+        )
+        results.append(
+            "  ".join(
+                [
+                    completed,
+                    priority,
+                    completion_date,
+                    creation_date,
+                    description,
+                    additions,
+                ]
+            )
+        )
+    return "\n".join(results)
+
+
+def _date_to_str(date: datetime.date | None) -> str:
+    if date is None:
+        return "".ljust(14)
+    return date.strftime("%a %Y-%m-%d")
+
+
+def _get_todo_txt_content() -> str:
+    todo_file_path = os.path.join(TODO_DIR, "todo.txt")
+    if not os.path.isfile(todo_file_path):
+        return ""
+    with open(todo_file_path, "r") as f:
+        return f.read()

zrb/callback/any_callback.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from typing import Any
 
-from ..context.any_shared_context import AnySharedContext
+from zrb.context.any_shared_context import AnySharedContext
 
 
 class AnyCallback(ABC):

zrb/callback/callback.py

@@ -1,10 +1,10 @@
 from typing import Any
 
-from ..attr.type import StrDictAttr
-from ..session.any_session import AnySession
-from ..task.any_task import AnyTask
-from ..util.attr import get_str_dict_attr
-from .any_callback import AnyCallback
+from zrb.attr.type import StrDictAttr
+from zrb.callback.any_callback import AnyCallback
+from zrb.session.any_session import AnySession
+from zrb.task.any_task import AnyTask
+from zrb.util.attr import get_str_dict_attr
 
 
 class Callback(AnyCallback):

zrb/cmd/cmd_val.py

@@ -1,8 +1,8 @@
 from abc import ABC, abstractmethod
 from collections.abc import Callable
 
-from ..attr.type import fstring
-from ..context.context import Context
+from zrb.attr.type import fstring
+from zrb.context.context import Context
 
 
 class AnyCmdVal(ABC):

zrb/config.py

@@ -3,7 +3,7 @@ import logging
 import os
 import platform
 
-from .util.string.conversion import to_boolean
+from zrb.util.string.conversion import to_boolean
 
 
 def _get_current_shell() -> str:
@@ -53,8 +53,11 @@ SHOW_PROMPT = to_boolean(os.getenv("ZRB_SHOW_PROMPT", "1"))
 SESSION_LOG_DIR = os.getenv(
     "ZRB_SESSION_LOG_DIR", os.path.expanduser(os.path.join("~", ".zrb-session"))
 )
+TODO_DIR = os.getenv("ZRB_TODO_DIR", os.path.expanduser(os.path.join("~", "todo")))
 VERSION = metadata.version("zrb")
 WEB_HTTP_PORT = int(os.getenv("ZRB_WEB_HTTP_PORT", "21213"))
+LLM_MODEL = os.getenv("ZRB_LLM_MODEL", "ollama_chat/llama3.1")
+LLM_SYSTEM_PROMPT = os.getenv("ZRB_LLM_SYSTEM_PROMPT", "You are a helpful assistant")
 
 BANNER = f"""
                 bb

zrb/content_transformer/any_content_transformer.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from ..context.any_context import AnyContext
+from zrb.context.any_context import AnyContext
 
 
 class AnyContentTransformer(ABC):

zrb/content_transformer/content_transformer.py

@@ -2,8 +2,8 @@ import fnmatch
 import re
 from collections.abc import Callable
 
-from ..context.any_context import AnyContext
-from .any_content_transformer import AnyContentTransformer
+from zrb.content_transformer.any_content_transformer import AnyContentTransformer
+from zrb.context.any_context import AnyContext
 
 
 class ContentTransformer(AnyContentTransformer):

zrb/context/any_context.py

@@ -2,7 +2,7 @@ import sys
 from abc import abstractmethod
 from typing import TextIO
 
-from .any_shared_context import AnySharedContext
+from zrb.context.any_shared_context import AnySharedContext
 
 
 class AnyContext(AnySharedContext):

zrb/context/any_shared_context.py

@@ -3,11 +3,11 @@ from __future__ import annotations  # Enables forward references
 from abc import ABC, abstractmethod
 from typing import TYPE_CHECKING, Any
 
-from ..dot_dict.dot_dict import DotDict
-from ..xcom.xcom import Xcom
+from zrb.dot_dict.dot_dict import DotDict
+from zrb.xcom.xcom import Xcom
 
 if TYPE_CHECKING:
-    from ..session import any_session
+    from zrb.session import any_session
 
 
 class AnySharedContext(ABC):

zrb/context/context.py

@@ -4,12 +4,12 @@ import re
 import sys
 from typing import Any, TextIO
 
-from ..dot_dict.dot_dict import DotDict
-from ..session.any_session import AnySession
-from ..util.cli.style import stylize, stylize_error, stylize_log, stylize_warning
-from ..util.string.conversion import to_boolean
-from .any_context import AnyContext
-from .any_shared_context import AnySharedContext
+from zrb.context.any_context import AnyContext
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.dot_dict.dot_dict import DotDict
+from zrb.session.any_session import AnySession
+from zrb.util.cli.style import stylize, stylize_error, stylize_log, stylize_warning
+from zrb.util.string.conversion import to_boolean
 
 
 def _remove_ansi_escape_sequences(text):
@@ -103,14 +103,16 @@ class Context(AnyContext):
     ):
         color = self._color
         icon = self._icon
-        task_name = self._task_name.rjust(15)
+        max_name_length = max(len(name) + len(icon) for name in self.session.task_names)
+        styled_task_name = f"{icon} {self._task_name}"
+        padded_styled_task_name = styled_task_name.rjust(max_name_length + 1)
         if self._attempt == 0:
             attempt_status = "".ljust(5)
         else:
             attempt_status = f"{self._attempt}/{self._max_attempt}".ljust(5)
         now = datetime.datetime.now()
         formatted_time = now.strftime("%y%m%d %H:%M:%S.%f")[:19]
-        prefix = f"{formatted_time} {attempt_status} {icon} {task_name} ⬤ "
+        prefix = f"{formatted_time} {attempt_status} {padded_styled_task_name} ⬤ "
         message = sep.join([f"{value}" for value in values])
         self.append_to_shared_log(_remove_ansi_escape_sequences(f"{prefix} {message}"))
         stylized_prefix = stylize(prefix, color=color)

zrb/context/shared_context.py

@@ -1,10 +1,12 @@
 import datetime
 from typing import Any
 
-from ..config import LOGGING_LEVEL
-from ..dot_dict.dot_dict import DotDict
-from ..session.any_session import AnySession
-from ..util.string.conversion import (
+from zrb.config import LOGGING_LEVEL
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.dot_dict.dot_dict import DotDict
+from zrb.session.any_session import AnySession
+from zrb.util.string.conversion import (
+    double_quote,
     to_boolean,
     to_camel_case,
     to_human_case,
@@ -12,9 +14,8 @@ from ..util.string.conversion import (
     to_pascal_case,
     to_snake_case,
 )
-from ..util.string.format import fstring_format
-from ..xcom.xcom import Xcom
-from .any_shared_context import AnySharedContext
+from zrb.util.string.format import fstring_format
+from zrb.xcom.xcom import Xcom
 
 
 class SharedContext(AnySharedContext):
@@ -86,12 +87,12 @@ class SharedContext(AnySharedContext):
             data={
                 "ctx": self,
                 "datetime": datetime,
-                "Xcom": Xcom,
                 "to_boolean": to_boolean,
                 "to_camel_case": to_camel_case,
                 "to_human_case": to_human_case,
                 "to_kebab_case": to_kebab_case,
                 "to_pascal_case": to_pascal_case,
                 "to_snake_case": to_snake_case,
+                "double_quote": double_quote,
             },
         )

zrb/env/__init__.py

@@ -1,3 +0,0 @@
-from .env import Env
-
-assert Env

zrb/env/any_env.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from ..context.any_shared_context import AnySharedContext
+from zrb.context.any_shared_context import AnySharedContext
 
 
 class AnyEnv(ABC):

zrb/env/env.py

@@ -1,10 +1,9 @@
 import os
 
+from zrb.attr.type import StrAttr
 from zrb.context.any_shared_context import AnySharedContext
-
-from ..attr.type import StrAttr
-from ..util.attr import get_str_attr
-from .any_env import AnyEnv
+from zrb.env.any_env import AnyEnv
+from zrb.util.attr import get_str_attr
 
 
 class Env(AnyEnv):

zrb/env/env_file.py

@@ -1,9 +1,9 @@
 from dotenv import dotenv_values
 
-from ..attr.type import StrAttr
-from ..context.shared_context import SharedContext
-from ..util.attr import get_str_attr
-from .env_map import EnvMap
+from zrb.attr.type import StrAttr
+from zrb.context.shared_context import SharedContext
+from zrb.env.env_map import EnvMap
+from zrb.util.attr import get_str_attr
 
 
 class EnvFile(EnvMap):

zrb/env/env_map.py

@@ -1,8 +1,8 @@
 import os
 from collections.abc import Callable
 
-from ..context.shared_context import SharedContext
-from .any_env import AnyEnv
+from zrb.context.shared_context import SharedContext
+from zrb.env.any_env import AnyEnv
 
 
 class EnvMap(AnyEnv):

zrb/group/__init__.py

@@ -1,3 +0,0 @@
-from .group import Group
-
-assert Group

zrb/group/any_group.py

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
-from typing import Optional
+from typing import Optional, Union
 
-from ..task.any_task import AnyTask
+from zrb.task.any_task import AnyTask
 
 
 class AnyGroup(ABC):
@@ -36,7 +36,7 @@ class AnyGroup(ABC):
         pass
 
     @abstractmethod
-    def add_group(self, group: "AnyGroup") -> "AnyGroup":
+    def add_group(self, group: Union["AnyGroup", str]) -> "AnyGroup":
         pass
 
     @abstractmethod

zrb/group/group.py

@@ -1,5 +1,5 @@
-from ..task.any_task import AnyTask
-from .any_group import AnyGroup
+from zrb.group.any_group import AnyGroup
+from zrb.task.any_task import AnyTask
 
 
 class Group(AnyGroup):
@@ -42,10 +42,11 @@ class Group(AnyGroup):
         alias.sort()
         return {name: self._tasks.get(name) for name in alias}
 
-    def add_group(self, group: AnyGroup, alias: str | None = None) -> AnyGroup:
-        alias = alias if alias is not None else group.name
-        self._groups[alias] = group
-        return group
+    def add_group(self, group: AnyGroup | str, alias: str | None = None) -> AnyGroup:
+        real_group = Group(group) if isinstance(group, str) else group
+        alias = alias if alias is not None else real_group.name
+        self._groups[alias] = real_group
+        return real_group
 
     def add_task(self, task: AnyTask, alias: str | None = None) -> AnyTask:
         alias = alias if alias is not None else task.name

zrb/input/any_input.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from ..context.any_shared_context import AnySharedContext
+from zrb.context.any_shared_context import AnySharedContext
 
 
 class AnyInput(ABC):

zrb/input/base_input.py

@@ -1,9 +1,9 @@
 from typing import Any
 
-from ..attr.type import StrAttr
-from ..context.any_shared_context import AnySharedContext
-from ..util.attr import get_str_attr
-from .any_input import AnyInput
+from zrb.attr.type import StrAttr
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.any_input import AnyInput
+from zrb.util.attr import get_str_attr
 
 
 class BaseInput(AnyInput):

zrb/input/bool_input.py

@@ -1,10 +1,10 @@
-from ..attr.type import StrAttr
-from ..context.any_shared_context import AnySharedContext
-from ..util.string.conversion import to_boolean
-from .base_input import BaseInput
+from zrb.attr.type import StrAttr
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
+from zrb.util.string.conversion import to_boolean
 
 
-class IntInput(BaseInput):
+class BoolInput(BaseInput):
     def __init__(
         self,
         name: str,

zrb/input/float_input.py

@@ -1,6 +1,6 @@
-from ..attr.type import StrAttr
-from ..context.any_shared_context import AnySharedContext
-from .base_input import BaseInput
+from zrb.attr.type import StrAttr
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
 
 
 class FloatInput(BaseInput):

zrb/input/int_input.py

@@ -1,6 +1,6 @@
-from ..attr.type import StrAttr
-from ..context.any_shared_context import AnySharedContext
-from .base_input import BaseInput
+from zrb.attr.type import StrAttr
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
 
 
 class IntInput(BaseInput):

zrb/input/option_input.py

@@ -0,0 +1,51 @@
+from zrb.attr.type import StrAttr, StrListAttr
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
+from zrb.util.attr import get_str_list_attr
+
+
+class OptionInput(BaseInput):
+    def __init__(
+        self,
+        name: str,
+        description: str | None = None,
+        prompt: str | None = None,
+        options: StrListAttr = [],
+        default_str: StrAttr = "",
+        auto_render: bool = True,
+        allow_empty: bool = True,
+    ):
+        super().__init__(
+            name=name,
+            description=description,
+            prompt=prompt,
+            default_str=default_str,
+            auto_render=auto_render,
+            allow_empty=allow_empty,
+        )
+        self._options = options
+
+    def to_html(self, ctx: AnySharedContext) -> str:
+        name = self.name
+        description = self.description
+        default = self._get_default_str(ctx)
+        html = [f'<select name="{name}" placeholder="{description}">']
+        for value in get_str_list_attr(ctx, self._options, self._auto_render):
+            selected = "selected" if value == default else ""
+            html.append(f'<option value="{value}" {selected}>{value}</option>')
+        html.append("</select>")
+        return "\n".join(html)
+
+    def _prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
+        prompt_message = self.prompt_message
+        default_value = self._get_default_str(shared_ctx)
+        options = get_str_list_attr(shared_ctx, self._options, self._auto_render)
+        option_str = ", ".join(options)
+        if default_value != "":
+            prompt_message = f"{prompt_message} ({option_str}) [{default_value}]"
+        value = input(f"{prompt_message}: ")
+        if value.strip() != "" and value.strip() not in options:
+            value = self._prompt_cli_str(shared_ctx)
+        if value.strip() == "":
+            value = default_value
+        return value

zrb/input/password_input.py

@@ -1,8 +1,8 @@
 import getpass
 from collections.abc import Callable
 
-from ..context.any_shared_context import AnySharedContext
-from .base_input import BaseInput
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
 
 
 class PasswordInput(BaseInput):

zrb/input/str_input.py

@@ -1,4 +1,4 @@
-from .base_input import BaseInput
+from zrb.input.base_input import BaseInput
 
 
 class StrInput(BaseInput):

zrb/input/text_input.py

@@ -1,10 +1,11 @@
+import os
 import subprocess
 import tempfile
 from collections.abc import Callable
 
-from ..config import DEFAULT_EDITOR
-from ..context.any_shared_context import AnySharedContext
-from .base_input import BaseInput
+from zrb.config import DEFAULT_EDITOR
+from zrb.context.any_shared_context import AnySharedContext
+from zrb.input.base_input import BaseInput
 
 
 class TextInput(BaseInput):
@@ -66,14 +67,15 @@ class TextInput(BaseInput):
 
     def _prompt_cli_str(self, shared_ctx: AnySharedContext) -> str:
         prompt_message = (
-            f"{self.comment_start}{super().prompt_message}{self.comment_end}\n"
+            f"{self.comment_start}{super().prompt_message}{self.comment_end}"
         )
+        prompt_message_eol = f"{prompt_message}\n"
         default_value = self._get_default_str(shared_ctx)
         with tempfile.NamedTemporaryFile(
             delete=False, suffix=self._extension
         ) as temp_file:
             temp_file_name = temp_file.name
-            temp_file.write(prompt_message.encode())
+            temp_file.write(prompt_message_eol.encode())
             # Pre-fill with default content
             if default_value:
                 temp_file.write(default_value.encode())
@@ -82,8 +84,8 @@ class TextInput(BaseInput):
         subprocess.call([self._editor, temp_file_name])
         # Read the edited content
         with open(temp_file_name, "r") as temp_file:
-            edited_content = temp_file.read().strip()
-            parts = edited_content.split(prompt_message)
-            if len(parts) == 2 and parts[0].strip() == "":
-                edited_content = parts[1]
-        return edited_content.strip() if edited_content.strip() else default_value
+            edited_content = temp_file.read()
+            parts = [text.strip() for text in edited_content.split(prompt_message, 1)]
+            edited_content = "\n".join(parts).lstrip()
+        os.remove(temp_file_name)
+        return edited_content