fabricatio 0.2.0.dev19__tar.gz → 0.2.0.dev20__tar.gz

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/.github/workflows/build-package.yaml

@@ -49,7 +49,7 @@ jobs:
           rustup default nightly
       - name: Install deps
         run: |
-          uv sync --no-install-project  --all-extras
+          uv sync --no-install-project  --all-extras --index https://pypi.org/simple
       - name: Build
         run: |
           make

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/.github/workflows/tests.yaml

@@ -22,8 +22,8 @@ jobs:
 
       - name: Install deps
         run: |
-          uv sync
-
+          uv sync --no-install-project  --all-extras --index https://pypi.org/simple
+          make dev
       - name: Build
         run: |
           pytest tests

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.0.dev19
+Version: 0.2.0.dev20
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -10,6 +10,7 @@ Classifier: Framework :: Pydantic :: 2
 Classifier: Typing :: Typed
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: asyncio>=3.4.3
+Requires-Dist: asyncstdlib>=3.13.0
 Requires-Dist: code2prompt
 Requires-Dist: gitpython>=3.1.44
 Requires-Dist: litellm>=1.60.0
@@ -47,26 +48,28 @@ Fabricatio is a powerful framework designed to facilitate the creation and manag
 
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Defining a Task](#defining-a-task)
-    - [Creating an Action](#creating-an-action)
-    - [Assigning a Role](#assigning-a-role)
-    - [Logging](#logging)
+  - [Defining a Task](#defining-a-task)
+  - [Creating an Action](#creating-an-action)
+  - [Assigning a Role](#assigning-a-role)
+  - [Logging](#logging)
 - [Configuration](#configuration)
-    - [LLM Configuration](#llm-configuration)
-    - [Debug Configuration](#debug-configuration)
+  - [LLM Configuration](#llm-configuration)
+  - [Debug Configuration](#debug-configuration)
 - [Examples](#examples)
-    - [Simple Task Example](#simple-task-example)
-    - [Complex Workflow Example](#complex-workflow-example)
+  - [Simple Task Example](#simple-task-example)
+  - [Complex Workflow Example](#complex-workflow-example)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## Installation
+
 To install Fabricatio, you can use pip:
 
 ```bash
 pip install fabricatio
 ```
 
+
 Alternatively, you can clone the repository and install it manually:
 
 ```bash
@@ -231,3 +234,109 @@ Contributions to Fabricatio are welcome! Please submit a pull request with your
 
 Fabricatio is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
 
+---
+
+### Additional Features and Modules
+
+#### Advanced Models and Functionalities
+
+The `advanced.py` module provides advanced models and functionalities for handling complex tasks and workflows.
+
+```python
+from fabricatio.models.advanced import ProposeTask, HandleTask
+
+class ProposeTaskExample(ProposeTask):
+    pass
+
+class HandleTaskExample(HandleTask):
+    pass
+```
+
+
+#### Toolboxes
+
+Fabricatio includes various toolboxes for different types of operations. For example, the `arithmetic.py` toolbox provides arithmetic operations.
+
+```python
+from fabricatio.toolboxes.arithmetic import add, subtract, multiply, divide
+
+result = add(1, 2)
+print(result)  # Output: 3
+```
+
+
+#### File System Operations
+
+The `fs.py` toolbox offers tools for file system operations such as copying, moving, deleting files, and creating directories.
+
+```python
+from fabricatio.toolboxes.fs import copy_file, move_file, delete_file, create_directory
+
+copy_file("source.txt", "destination.txt")
+move_file("old_location.txt", "new_location.txt")
+delete_file("file_to_delete.txt")
+create_directory("new_directory")
+```
+
+
+#### Logging Setup
+
+The logging setup in Fabricatio is handled by the `journal.py` module, which configures Loguru for logging.
+
+```python
+from fabricatio.journal import logger
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.success("This is a success message.")
+logger.warning("This is a warning message.")
+logger.error("This is an error message.")
+logger.critical("This is a critical message.")
+```
+
+
+#### Configuration Management
+
+The configuration management in Fabricatio is handled by the `config.py` module, which uses Pydantic for defining and validating configurations.
+
+```python
+from fabricatio.config import Settings, LLMConfig, DebugConfig
+
+settings = Settings()
+llm_config = LLMConfig(api_endpoint="https://api.example.com")
+debug_config = DebugConfig(log_level="DEBUG", log_file="fabricatio.log")
+```
+
+
+#### Testing
+
+Fabricatio includes a suite of test cases to ensure the stability and correctness of the codebase. The tests are located in the `tests` directory and cover various modules and functionalities.
+
+```python
+# Example of a test case for the config module
+import pytest
+from fabricatio.config import DebugConfig
+
+def test_debug_config_initialization():
+    temp_log_file = "fabricatio.log"
+    debug_config = DebugConfig(log_level="DEBUG", log_file=temp_log_file)
+    assert debug_config.log_level == "DEBUG"
+    assert str(debug_config.log_file) == temp_log_file
+```
+
+
+---
+
+### Conclusion
+
+Fabricatio is a versatile and powerful framework for managing tasks, actions, and workflows. It provides a robust set of tools and features to facilitate task automation and orchestration. Whether you're building a simple script or a complex application, Fabricatio has the capabilities to meet your needs.
+
+For more detailed information and examples, please refer to the [official documentation](https://fabricatio.readthedocs.io).
+
+---
+
+If you have any questions or need further assistance, feel free to reach out to the community or open an issue on the GitHub repository.
+
+Happy coding!
+
+

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/README.md

@@ -8,26 +8,28 @@ Fabricatio is a powerful framework designed to facilitate the creation and manag
 
 - [Installation](#installation)
 - [Usage](#usage)
-    - [Defining a Task](#defining-a-task)
-    - [Creating an Action](#creating-an-action)
-    - [Assigning a Role](#assigning-a-role)
-    - [Logging](#logging)
+  - [Defining a Task](#defining-a-task)
+  - [Creating an Action](#creating-an-action)
+  - [Assigning a Role](#assigning-a-role)
+  - [Logging](#logging)
 - [Configuration](#configuration)
-    - [LLM Configuration](#llm-configuration)
-    - [Debug Configuration](#debug-configuration)
+  - [LLM Configuration](#llm-configuration)
+  - [Debug Configuration](#debug-configuration)
 - [Examples](#examples)
-    - [Simple Task Example](#simple-task-example)
-    - [Complex Workflow Example](#complex-workflow-example)
+  - [Simple Task Example](#simple-task-example)
+  - [Complex Workflow Example](#complex-workflow-example)
 - [Contributing](#contributing)
 - [License](#license)
 
 ## Installation
+
 To install Fabricatio, you can use pip:
 
 ```bash
 pip install fabricatio
 ```
 
+
 Alternatively, you can clone the repository and install it manually:
 
 ```bash
@@ -191,3 +193,109 @@ Contributions to Fabricatio are welcome! Please submit a pull request with your
 ## License
 
 Fabricatio is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
+
+---
+
+### Additional Features and Modules
+
+#### Advanced Models and Functionalities
+
+The `advanced.py` module provides advanced models and functionalities for handling complex tasks and workflows.
+
+```python
+from fabricatio.models.advanced import ProposeTask, HandleTask
+
+class ProposeTaskExample(ProposeTask):
+    pass
+
+class HandleTaskExample(HandleTask):
+    pass
+```
+
+
+#### Toolboxes
+
+Fabricatio includes various toolboxes for different types of operations. For example, the `arithmetic.py` toolbox provides arithmetic operations.
+
+```python
+from fabricatio.toolboxes.arithmetic import add, subtract, multiply, divide
+
+result = add(1, 2)
+print(result)  # Output: 3
+```
+
+
+#### File System Operations
+
+The `fs.py` toolbox offers tools for file system operations such as copying, moving, deleting files, and creating directories.
+
+```python
+from fabricatio.toolboxes.fs import copy_file, move_file, delete_file, create_directory
+
+copy_file("source.txt", "destination.txt")
+move_file("old_location.txt", "new_location.txt")
+delete_file("file_to_delete.txt")
+create_directory("new_directory")
+```
+
+
+#### Logging Setup
+
+The logging setup in Fabricatio is handled by the `journal.py` module, which configures Loguru for logging.
+
+```python
+from fabricatio.journal import logger
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.success("This is a success message.")
+logger.warning("This is a warning message.")
+logger.error("This is an error message.")
+logger.critical("This is a critical message.")
+```
+
+
+#### Configuration Management
+
+The configuration management in Fabricatio is handled by the `config.py` module, which uses Pydantic for defining and validating configurations.
+
+```python
+from fabricatio.config import Settings, LLMConfig, DebugConfig
+
+settings = Settings()
+llm_config = LLMConfig(api_endpoint="https://api.example.com")
+debug_config = DebugConfig(log_level="DEBUG", log_file="fabricatio.log")
+```
+
+
+#### Testing
+
+Fabricatio includes a suite of test cases to ensure the stability and correctness of the codebase. The tests are located in the `tests` directory and cover various modules and functionalities.
+
+```python
+# Example of a test case for the config module
+import pytest
+from fabricatio.config import DebugConfig
+
+def test_debug_config_initialization():
+    temp_log_file = "fabricatio.log"
+    debug_config = DebugConfig(log_level="DEBUG", log_file=temp_log_file)
+    assert debug_config.log_level == "DEBUG"
+    assert str(debug_config.log_file) == temp_log_file
+```
+
+
+---
+
+### Conclusion
+
+Fabricatio is a versatile and powerful framework for managing tasks, actions, and workflows. It provides a robust set of tools and features to facilitate task automation and orchestration. Whether you're building a simple script or a complex application, Fabricatio has the capabilities to meet your needs.
+
+For more detailed information and examples, please refer to the [official documentation](https://fabricatio.readthedocs.io).
+
+---
+
+If you have any questions or need further assistance, feel free to reach out to the community or open an issue on the GitHub repository.
+
+Happy coding!
+

fabricatio-0.2.0.dev20/examples/llm_usages/llm_usage.py

@@ -0,0 +1,60 @@
+"""Example of using the library."""
+
+import asyncio
+
+from fabricatio import Action, Role, Task, WorkFlow
+from fabricatio.journal import logger
+from fabricatio.models.events import Event
+from fabricatio.parser import PythonCapture
+
+
+class WriteCode(Action):
+    """Action that says hello to the world."""
+
+    name: str = "write code"
+    output_key: str = "task_output"
+
+    async def _execute(self, task_input: Task[str], **_) -> str:
+        return await self.aask_validate(
+            task_input.briefing,
+            validator=PythonCapture.capture,
+        )
+
+
+class WriteDocumentation(Action):
+    """Action that says hello to the world."""
+
+    name: str = "write documentation"
+    description: str = "write documentation for the code in markdown format"
+    output_key: str = "task_output"
+
+    async def _execute(self, task_input: Task[str], **_) -> str:
+        return await self.aask(task_input.briefing, task_input.dependencies_prompt)
+
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="Coder",
+        description="A python coder who can write code and documentation",
+        registry={
+            Event.instantiate_from("coding.*").push("pending"): WorkFlow(name="write code", steps=(WriteCode,)),
+            Event.instantiate_from("doc.*").push("pending"): WorkFlow(
+                name="write documentation", steps=(WriteDocumentation,)
+            ),
+        },
+    )
+
+    prompt = "write a python cli app which can add a list of numbers writen in a file together,with detailed google style documentation."
+
+    proposed_task = await role.propose(prompt)
+    code = await proposed_task.move_to("coding").delegate()
+    logger.success(f"Code: \n{code}")
+
+    proposed_task = await role.propose(f"{code} \n\n write Readme.md file for the code.")
+    doc = await proposed_task.move_to("doc").delegate()
+    logger.success(f"Documentation: \n{doc}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/examples/propose_task/propose.py

@@ -14,7 +14,7 @@ class Talk(Action):
     name: str = "talk"
     output_key: str = "task_output"
 
-    async def _execute(self, task_input: Task[str], **_) -> Any:
+    async def _execute(self, **_) -> Any:
         ret = "Hello fabricatio!"
         logger.info("executing talk action")
         return ret

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.0-dev.19"
+version = "0.2.0-dev.20"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -29,6 +29,7 @@ requires-python = ">=3.12"
 dependencies = [
     "appdirs>=1.4.4",
     "asyncio>=3.4.3",
+    "asyncstdlib>=3.13.0",
     "code2prompt",
     "gitpython>=3.1.44",
     "litellm>=1.60.0",
@@ -137,6 +138,8 @@ addopts = "-ra -q"
 testpaths = [
     "tests",
 ]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 
 [tool.uv.sources]
 code2prompt = { git = "https://github.com/mufeedvh/code2prompt", rev = "d157ee84827458bd6816142e213886487d28bd3d" }

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/_rust.pyi

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 
 class TemplateManager:
     """TemplateManager class for managing handlebars templates."""
@@ -31,12 +31,12 @@ class TemplateManager:
     def discover_templates(self) -> None:
         """Discover templates in the specified directories."""
 
-    def render_template(self, name: str, data: Dict[str, str]) -> str:
+    def render_template(self, name: str, data: Dict[str, Any]) -> str:
         """Render a template with the given name and data.
 
         Args:
             name (str): The name of the template to render.
-            data (Dict[str, str]): The data to pass to the template.
+            data (Dict[str, Any]): The data to pass to the template.
 
         Returns:
             str: The rendered template.

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/config.py

@@ -115,6 +115,15 @@ class DebugConfig(BaseModel):
     log_file: FilePath = Field(default=rf"{ROAMING_DIR}\fabricatio.log")
     """The log file of the application."""
 
+    rotation: int = Field(default=1)
+    """The rotation of the log file. in weeks."""
+
+    retention: int = Field(default=2)
+    """The retention of the log file. in weeks."""
+
+    streaming_visible: bool = Field(default=False)
+    """Whether to print the llm output when streaming."""
+
 
 class TemplateConfig(BaseModel):
     """Template configuration class."""
@@ -145,6 +154,9 @@ class TemplateConfig(BaseModel):
     dependencies_template: str = Field(default="dependencies")
     """The name of the dependencies template which will be used to manage dependencies."""
 
+    task_briefing_template: str = Field(default="task_briefing")
+    """The name of the task briefing template which will be used to brief a task."""
+
 
 class MagikaConfig(BaseModel):
     """Magika configuration class."""

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/journal.py

@@ -3,17 +3,22 @@
 import sys
 
 from loguru import logger
-from rich import traceback
+from rich import pretty, traceback
 
 from fabricatio.config import configs
 
+pretty.install()
 traceback.install()
 logger.remove()
 logger.add(
-    configs.debug.log_file, level=configs.debug.log_level, rotation="1 weeks", retention="1 month", compression="zip"
+    configs.debug.log_file,
+    level=configs.debug.log_level,
+    rotation=f"{configs.debug.rotation} weeks",
+    retention=f"{configs.debug.retention} weeks",
 )
 logger.add(sys.stderr, level=configs.debug.log_level)
 
+
 if __name__ == "__main__":
     logger.debug("This is a trace message.")
     logger.info("This is an information message.")

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/models/action.py

@@ -111,7 +111,13 @@ class WorkFlow[A: Union[Type[Action], Action]](WithBriefing, ToolBoxUsage):
                 await self._context.put(modified_ctx)
                 current_action = step.name
             logger.info(f"Finished executing workflow: {self.name}")
-            await task.finish((await self._context.get()).get(self.task_output_key, None))
+            final_ctx = await self._context.get()
+            if self.task_output_key not in final_ctx:
+                logger.warning(
+                    f"Task output key: {self.task_output_key} not found in the context, None will be returned. You can check if `Action.output_key` is set the same as `WorkFlow.task_output_key`."
+                )
+
+            await task.finish(final_ctx.get(self.task_output_key, None))
         except RuntimeError as e:
             logger.error(f"Error during task: {current_action} execution: {e}")  # Log the exception
             logger.error(traceback.format_exc())  # Add this line to log the traceback

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/models/generic.py

@@ -109,7 +109,8 @@ class WithDependency(Base):
         return template_manager.render_template(
             configs.templates.dependencies_template,
             {
-                (pth := Path(p)).as_posix(): {
+                (pth := Path(p)).name: {
+                    "path": pth.as_posix(),
                     "exists": pth.exists(),
                     "description": (identity := magika.identify_path(pth)).output.description,
                     "size": f"{pth.stat().st_size / (1024 * 1024) if pth.exists() and pth.is_file() else 0:.3f} MB",

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/models/task.py

@@ -7,6 +7,8 @@ from asyncio import Queue
 from enum import Enum
 from typing import Any, List, Optional, Self
 
+from fabricatio._rust_instances import template_manager
+from fabricatio.config import configs
 from fabricatio.core import env
 from fabricatio.journal import logger
 from fabricatio.models.events import Event, EventLike
@@ -214,7 +216,7 @@ class Task[T](WithBriefing, WithJsonExample, WithDependency):
         Returns:
             Task: The running instance of the `Task` class.
         """
-        logger.info(f"Starting task {self.name}")
+        logger.info(f"Starting task `{self.name}`")
         self._status = TaskStatus.Running
         await env.emit_async(self.running_label, self)
         return self
@@ -225,6 +227,7 @@ class Task[T](WithBriefing, WithJsonExample, WithDependency):
         Returns:
             Task: The cancelled instance of the `Task` class.
         """
+        logger.info(f"Cancelling task `{self.name}`")
         self._status = TaskStatus.Cancelled
         await env.emit_async(self.cancelled_label, self)
         return self
@@ -235,7 +238,7 @@ class Task[T](WithBriefing, WithJsonExample, WithDependency):
         Returns:
             Task: The failed instance of the `Task` class.
         """
-        logger.error(f"Task {self.name} failed")
+        logger.info(f"Failing task `{self.name}`")
         self._status = TaskStatus.Failed
         await env.emit_async(self.failed_label, self)
         return self
@@ -267,4 +270,7 @@ class Task[T](WithBriefing, WithJsonExample, WithDependency):
         Returns:
             str: The briefing of the task.
         """
-        return f"{super().briefing}\n{self.goal}"
+        return template_manager.render_template(
+            configs.templates.task_briefing_template,
+            self.model_dump(include={"name", "description", "dependencies", "goal"}),
+        )

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/python/fabricatio/models/usages.py

@@ -2,6 +2,7 @@
 
 from typing import Callable, Dict, Iterable, List, Optional, Self, Set, Union, Unpack
 
+import asyncstdlib
 import litellm
 import orjson
 from fabricatio._rust_instances import template_manager
@@ -13,7 +14,13 @@ from fabricatio.models.task import Task
 from fabricatio.models.tool import Tool, ToolBox
 from fabricatio.models.utils import Messages
 from fabricatio.parser import JsonCapture
-from litellm.types.utils import Choices, ModelResponse, StreamingChoices
+from litellm import stream_chunk_builder
+from litellm.types.utils import (
+    Choices,
+    ModelResponse,
+    StreamingChoices,
+)
+from litellm.utils import CustomStreamWrapper
 from pydantic import Field, HttpUrl, NonNegativeFloat, NonNegativeInt, PositiveInt, SecretStr
 
 
@@ -58,7 +65,7 @@ class LLMUsage(Base):
         messages: List[Dict[str, str]],
         n: PositiveInt | None = None,
         **kwargs: Unpack[LLMKwargs],
-    ) -> ModelResponse:
+    ) -> ModelResponse | CustomStreamWrapper:
         """Asynchronously queries the language model to generate a response based on the provided messages and parameters.
 
         Args:
@@ -105,13 +112,23 @@ class LLMUsage(Base):
         Returns:
             List[Choices | StreamingChoices]: A list of choices or streaming choices from the model response.
         """
-        return (
-            await self.aquery(
-                messages=Messages().add_system_message(system_message).add_user_message(question),
-                n=n,
-                **kwargs,
-            )
-        ).choices
+        resp = await self.aquery(
+            messages=Messages().add_system_message(system_message).add_user_message(question),
+            n=n,
+            **kwargs,
+        )
+        if isinstance(resp, ModelResponse):
+            return resp.choices
+        if isinstance(resp, CustomStreamWrapper):
+            if configs.debug.streaming_visible:
+                chunks = []
+                async for chunk in resp:
+                    chunks.append(chunk)
+                    print(chunk.choices[0].delta.content or "", end="")  # noqa: T201
+                return stream_chunk_builder(chunks).choices
+            return stream_chunk_builder(await asyncstdlib.list()).choices
+        logger.critical(err := f"Unexpected response type: {type(resp)}")
+        raise ValueError(err)
 
     async def aask(
         self,
@@ -137,10 +154,8 @@ class LLMUsage(Base):
                     system_message=system_message,
                     **kwargs,
                 )
-            )
-            .pop()
-            .message.content
-        )
+            ).pop()
+        ).message.content
 
     async def aask_validate[T](
         self,

{fabricatio-0.2.0.dev19 → fabricatio-0.2.0.dev20}/templates/built-in/dependencies.hbs

@@ -1,5 +1,6 @@
 {{#each this}}
 ### {{@key}}
+- **Path:** {{path}}
 - **Exists:** {{exists}}
 - **Description:** {{description}}
 - **Size:** {{size}}

fabricatio-0.2.0.dev20/templates/built-in/task_briefing.hbs

@@ -0,0 +1,8 @@
+Task Briefing:
+Name: {{name}}
+Description: {{description}}
+Dependencies:
+{{#each dependencies}}
+- `{{this}}`
+{{/each}}
+Goal: {{goal}}