fabricatio 0.2.0__cp312-cp312-win_amd64.whl

fabricatio/toolboxes/__init__.py

@@ -0,0 +1,17 @@
+"""Contains the built-in toolboxes for the Fabricatio package."""
+
+from typing import Set
+
+from fabricatio.models.tool import ToolBox
+from fabricatio.toolboxes.arithmetic import arithmetic_toolbox
+from fabricatio.toolboxes.fs import fs_toolbox
+from fabricatio.toolboxes.task import task_toolbox
+
+basic_toolboxes: Set[ToolBox] = {task_toolbox, arithmetic_toolbox}
+
+__all__ = [
+    "arithmetic_toolbox",
+    "basic_toolboxes",
+    "fs_toolbox",
+    "task_toolbox",
+]

fabricatio/toolboxes/arithmetic.py

@@ -0,0 +1,62 @@
+"""Arithmetic tools for Fabricatio."""
+
+from fabricatio.models.tool import ToolBox
+
+arithmetic_toolbox = ToolBox(name="ArithmeticToolBox", description="A toolbox for arithmetic operations.")
+
+
+@arithmetic_toolbox.collect_tool
+def add(a: float, b: float) -> float:
+    """Add two numbers.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        float: The sum of the two numbers.
+    """
+    return a + b
+
+
+@arithmetic_toolbox.collect_tool
+def subtract(a: float, b: float) -> float:
+    """Subtract two numbers.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        float: The result of subtracting b from a.
+    """
+    return a - b
+
+
+@arithmetic_toolbox.collect_tool
+def multiply(a: float, b: float) -> float:
+    """Multiply two numbers.
+
+    Args:
+        a (float): The first number.
+        b (float): The second number.
+
+    Returns:
+        float: The product of the two numbers.
+    """
+    return a * b
+
+
+@arithmetic_toolbox.collect_tool
+def divide(a: float, b: float) -> float:
+    """Divide two numbers.
+
+    Args:
+        a (float): The numerator.
+        b (float): The denominator (must not be zero).
+
+    Returns:
+        float: The result of dividing a by b.
+
+    """
+    return a / b

fabricatio/toolboxes/fs.py

@@ -0,0 +1,15 @@
+"""File system tool box."""
+
+from fabricatio.fs.curd import copy_file, create_directory, delete_directory, delete_file, dump_text, move_file, tree
+from fabricatio.models.tool import ToolBox
+
+fs_toolbox = (
+    ToolBox(name="FsToolBox", description="A toolbox for basic file system operations.")
+    .add_tool(dump_text)
+    .add_tool(copy_file)
+    .add_tool(move_file)
+    .add_tool(delete_file)
+    .add_tool(tree)
+    .add_tool(delete_directory)
+    .add_tool(create_directory)
+)

fabricatio/toolboxes/task.py

@@ -0,0 +1,6 @@
+"""This module contains the toolbox for tasks management."""
+
+from fabricatio.models.task import Task
+from fabricatio.models.tool import ToolBox
+
+task_toolbox = ToolBox(name="TaskToolBox", description="A toolbox for tasks management.").add_tool(Task.simple_task)

fabricatio-0.2.0.dist-info/METADATA

@@ -0,0 +1,342 @@
+Metadata-Version: 2.4
+Name: fabricatio
+Version: 0.2.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Framework :: AsyncIO
+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
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: magika>=0.5.1
+Requires-Dist: orjson>=3.10.15
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pydantic-settings>=2.7.1
+Requires-Dist: pymitter>=1.0.0
+Requires-Dist: questionary>=2.1.0
+Requires-Dist: regex>=2024.11.6
+Requires-Dist: rich>=13.9.4
+Requires-Dist: faiss-cpu>=1.10.0 ; extra == 'rag'
+Requires-Dist: pymilvus>=2.5.4 ; extra == 'rag'
+Requires-Dist: fabricatio[rag] ; extra == 'full'
+Provides-Extra: rag
+Provides-Extra: full
+License-File: LICENSE
+Summary: A LLM multi-agent framework.
+Keywords: ai,agents,multi-agent,llm,pyo3
+Author-email: Whth <zettainspector@foxmail.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/Whth/fabricatio
+Project-URL: Repository, https://github.com/Whth/fabricatio
+Project-URL: Issues, https://github.com/Whth/fabricatio/issues
+
+# Fabricatio
+
+---
+
+Fabricatio is a powerful framework designed to facilitate the creation and management of tasks, actions, and workflows. It leverages modern Python features and libraries to provide a robust and flexible environment for building applications that require task automation and orchestration.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [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)
+- [Examples](#examples)
+  - [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
+git clone https://github.com/your-repo/fabricatio.git
+cd fabricatio
+pip install .
+```
+
+
+## Usage
+
+### Defining a Task
+
+A task in Fabricatio is defined using the `Task` class. You can specify the name, goal, and description of the task.
+
+```python
+from fabricatio.models.task import Task
+
+task = Task(name="say hello", goal="say hello", description="say hello to the world")
+```
+
+
+### Creating an Action
+
+Actions are the building blocks of workflows. They perform specific tasks and can be asynchronous.
+
+```python
+from fabricatio import Action, logger
+from fabricatio.models.task import Task
+
+class Talk(Action):
+    async def _execute(self, task_input: Task[str], **_) -> str:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+```
+
+
+### Assigning a Role
+
+Roles in Fabricatio are responsible for executing workflows. You can define a role with a set of actions.
+
+```python
+from fabricatio.models.role import Role
+from fabricatio.models.action import WorkFlow
+
+class TestWorkflow(WorkFlow):
+    pass
+
+role = Role(name="Test Role", actions=[TestWorkflow()])
+```
+
+
+### Logging
+
+Fabricatio uses Loguru for logging. You can configure the log level and file in the `config.py` file.
+
+```python
+from fabricatio.config import DebugConfig
+
+debug_config = DebugConfig(log_level="DEBUG", log_file="fabricatio.log")
+```
+
+
+## Configuration
+
+Fabricatio uses Pydantic for configuration management. You can define your settings in the `config.py` file.
+
+### LLM Configuration
+
+The Large Language Model (LLM) configuration is managed by the `LLMConfig` class.
+
+```python
+from fabricatio.config import LLMConfig
+
+llm_config = LLMConfig(api_endpoint="https://api.example.com")
+```
+
+
+### Debug Configuration
+
+The debug configuration is managed by the `DebugConfig` class.
+
+```python
+from fabricatio.config import DebugConfig
+
+debug_config = DebugConfig(log_level="DEBUG", log_file="fabricatio.log")
+```
+
+
+## Examples
+
+### Simple Task Example
+
+Here is a simple example of a task that prints "Hello fabricatio!".
+
+```python
+import asyncio
+from fabricatio import Action, Role, Task, WorkFlow, logger
+
+task = Task(name="say hello", goal="say hello", description="say hello to the world")
+
+class Talk(Action):
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+
+class TestWorkflow(WorkFlow):
+    pass
+
+role = Role(name="Test Role", actions=[TestWorkflow()])
+
+async def main() -> None:
+    await role.act(task)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+
+### Complex Workflow Example
+
+Here is a more complex example that demonstrates how to create a workflow with multiple actions.
+
+```python
+import asyncio
+from fabricatio import Action, Role, Task, WorkFlow, logger
+
+task = Task(name="complex task", goal="perform complex operations", description="a task with multiple actions")
+
+class ActionOne(Action):
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Action One executed"
+        logger.info(ret)
+        return ret
+
+class ActionTwo(Action):
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Action Two executed"
+        logger.info(ret)
+        return ret
+
+class ComplexWorkflow(WorkFlow):
+    actions = [ActionOne(), ActionTwo()]
+
+role = Role(name="Complex Role", actions=[ComplexWorkflow()])
+
+async def main() -> None:
+    await role.act(task)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+
+## Contributing
+
+Contributions to Fabricatio are welcome! Please submit a pull request with your changes.
+
+## 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.dist-info/RECORD

@@ -0,0 +1,35 @@
+fabricatio-0.2.0.dist-info/METADATA,sha256=TDbPeQPnN7H9QpWnZp2lnaEnFVfDQYjD7RsDTHEeVGE,9658
+fabricatio-0.2.0.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
+fabricatio-0.2.0.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/communication.py,sha256=NZxIIncKgJSDyBrqNebUtH_haqtxHa8ld2TZxT3CMdU,429
+fabricatio/actions/transmission.py,sha256=xpvKqbXqgpi1BWy-vUUvmd8NZ1GhRNfsYUBp-l2jLyk,862
+fabricatio/actions/__init__.py,sha256=eFmFVPQvtNgFynIXBVr3eP-vWQDWCPng60YY5LXvZgg,115
+fabricatio/config.py,sha256=9wmISu5xOtC6C-bC_2pIK2iQMHs8Ah6VP7gnS4bHzRk,10259
+fabricatio/core.py,sha256=yQK2ZrbPYDJOaNDp0Bky3muTkB-ZaQ1ld_Qfflm2dY0,5938
+fabricatio/decorators.py,sha256=y-NFno3d_wxM0CAipsA7oRDeacYnbtVMnr9iQpTSptU,6492
+fabricatio/fs/curd.py,sha256=faMstgGUiQ4k2AW3OXfvvWWTldTtKXco7QINYaMjmyA,3981
+fabricatio/fs/readers.py,sha256=eDL9QhKEd6xfJBZaiwraObpGJWWpUd9NVYHoIvWgVqY,551
+fabricatio/fs/__init__.py,sha256=lWcKYg0v3mv2LnnSegOQaTtlVDODU0vtw_s6iKU5IqQ,122
+fabricatio/journal.py,sha256=siqimKF0M_QaaOCMxtjr_BJVNyUIAQWILzE9Q4T6-7c,781
+fabricatio/models/action.py,sha256=1V3upL79e3ekyGXA4bSY70N60yeL0aWak7ZPBVsFE3A,5652
+fabricatio/models/advanced.py,sha256=xAt0rgxzpw-gw-1LwRhvIbYKoNI8kzzcYPvcL7Q1z1U,5027
+fabricatio/models/events.py,sha256=mrihNEFgQ5o7qFWja1z_qX8dnaTLwPBoJdVlzxQV5oM,2719
+fabricatio/models/generic.py,sha256=rvrAUlW-mtHBkHUXmH7aNm9lpTbLLbKr9cWZk3lFTpc,4160
+fabricatio/models/kwargs_types.py,sha256=lSZAxOnhFdQwRkm-NrbJVMSyBbfdeuVNx807LvJpEOo,901
+fabricatio/models/role.py,sha256=RPdOcjmM6KNyH310Vx4524JQG94P5sXl_3doSrRpiKQ,1802
+fabricatio/models/task.py,sha256=qaN1LuGGfrtuIWKPqpPimoyniYnIVRcj7NeCdIVm4Rw,9185
+fabricatio/models/tool.py,sha256=m0wM1XmlvYvcrDvdKrX7qCIaxbzp5iUlG1ljc_uL5FE,7002
+fabricatio/models/usages.py,sha256=JwVanhu5v87LUbnPjwFPriFI5O3HG4SppesYvYLAb50,23636
+fabricatio/models/utils.py,sha256=i_kpcQpct04mQFk1nbcVGV-pl1YThWu4Qk3wbewzKkc,2535
+fabricatio/parser.py,sha256=ruCnb6gqnvZBNKxeWSGv3zqy492hbMpI-7rz_LjcPCA,3521
+fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
+fabricatio/toolboxes/fs.py,sha256=YkNgon5-bvCiPVEND9971W-6wj8btKNL6nGry2otn9I,498
+fabricatio/toolboxes/task.py,sha256=kU4a501awIDV7GwNDuSlK3_Ym-5OhCp5sS-insTmUmQ,269
+fabricatio/toolboxes/__init__.py,sha256=b13KmASO8q5fBLwew964fn9oH86ER5g-S1PgA4fZ_xs,482
+fabricatio/_rust.pyi,sha256=0wCqtwWkVxxoqprvk8T27T8QYKIAKHS7xgsmdMNjQKc,1756
+fabricatio/_rust_instances.py,sha256=dl0-yZ4UvT5g20tQgnPJpmqtkjFGXNG_YK4eLfi_ugQ,279
+fabricatio/__init__.py,sha256=opIrN8lGyT-h2If4Qez0bRuWBa3uIT9GsM9CZy7_XJ0,1100
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=UwUSgbb9eSitA_ZpsqGeM1RdNPjI-kht03jtrD_-Nrk,1260544
+fabricatio-0.2.0.data/scripts/tdown.exe,sha256=_vcAM4aXctQ5Net-OjI909_Ni9_ZnVMcUOafECCRb9A,3396608
+fabricatio-0.2.0.dist-info/RECORD,,

fabricatio-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.8.2)
+Root-Is-Purelib: false
+Tag: cp312-cp312-win_amd64

fabricatio-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Whth Yotta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.