fabricatio 0.2.6.dev1__cp312-cp312-manylinux_2_34_x86_64.whl → 0.2.6.dev2__cp312-cp312-manylinux_2_34_x86_64.whl

fabricatio/capabilities/correct.py

@@ -5,13 +5,13 @@ to provide mechanisms for reviewing, validating, and correcting various objects
 based on predefined criteria and templates.
 """
 
-from typing import Optional, Unpack
+from typing import Optional, Unpack, cast
 
 from fabricatio._rust_instances import TEMPLATE_MANAGER
 from fabricatio.capabilities.review import Review, ReviewResult
 from fabricatio.config import configs
 from fabricatio.models.generic import Display, ProposedAble, WithBriefing
-from fabricatio.models.kwargs_types import ReviewKwargs
+from fabricatio.models.kwargs_types import CorrectKwargs, ReviewKwargs
 from fabricatio.models.task import Task
 
 
@@ -25,7 +25,11 @@ class Correct(Review):
     """
 
     async def correct_obj[M: ProposedAble](
-        self, obj: M, **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]
+        self,
+        obj: M,
+        reference: str = "",
+        supervisor_check: bool = True,
+        **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]],
     ) -> Optional[M]:
         """Review and correct an object based on defined criteria and templates.
 
@@ -34,6 +38,8 @@ class Correct(Review):
 
         Args:
             obj (M): The object to be reviewed and corrected. Must implement ProposedAble.
+            reference (str): A reference or contextual information for the object.
+            supervisor_check (bool, optional): Whether to perform a supervisor check on the review results. Defaults to True.
             **kwargs: Review configuration parameters including criteria and review options.
 
         Returns:
@@ -44,23 +50,27 @@ class Correct(Review):
         """
         if not isinstance(obj, (Display, WithBriefing)):
             raise TypeError(f"Expected Display or WithBriefing, got {type(obj)}")
+
         review_res = await self.review_obj(obj, **kwargs)
-        await review_res.supervisor_check()
+        if supervisor_check:
+            await review_res.supervisor_check()
         if "default" in kwargs:
-            kwargs["default"] = None
+            cast(ReviewKwargs[None], kwargs)["default"] = None
         return await self.propose(
             obj.__class__,
             TEMPLATE_MANAGER.render_template(
                 configs.templates.correct_template,
                 {
-                    "content": obj.display() if isinstance(obj, Display) else obj.briefing,
+                    "content": f"{(reference + '\n\nAbove is referencing material') if reference else ''}{obj.display() if isinstance(obj, Display) else obj.briefing}",
                     "review": review_res.display(),
                 },
             ),
             **kwargs,
         )
 
-    async def correct_string(self, input_text: str, **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]) -> Optional[str]:
+    async def correct_string(
+        self, input_text: str, supervisor_check: bool = True, **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]
+    ) -> Optional[str]:
         """Review and correct a string based on defined criteria and templates.
 
         This method applies the review process to the input text and generates
@@ -68,16 +78,18 @@ class Correct(Review):
 
         Args:
             input_text (str): The text content to be reviewed and corrected.
+            supervisor_check (bool, optional): Whether to perform a supervisor check on the review results. Defaults to True.
             **kwargs: Review configuration parameters including criteria and review options.
 
         Returns:
             Optional[str]: The corrected text content, or None if correction fails.
         """
         review_res = await self.review_string(input_text, **kwargs)
-        await review_res.supervisor_check()
+        if supervisor_check:
+            await review_res.supervisor_check()
 
         if "default" in kwargs:
-            kwargs["default"] = None
+            cast(ReviewKwargs[None], kwargs)["default"] = None
         return await self.ageneric_string(
             TEMPLATE_MANAGER.render_template(
                 configs.templates.correct_template, {"content": input_text, "review": review_res.display()}
@@ -86,7 +98,7 @@ class Correct(Review):
         )
 
     async def correct_task[T](
-        self, task: Task[T], **kwargs: Unpack[ReviewKwargs[ReviewResult[str]]]
+        self, task: Task[T], **kwargs: Unpack[CorrectKwargs[ReviewResult[str]]]
     ) -> Optional[Task[T]]:
         """Review and correct a task object based on defined criteria.
 

fabricatio/models/kwargs_types.py

@@ -95,6 +95,17 @@ class ReviewKwargs[T](ValidateKwargs[T], total=False):
     criteria: set[str]
 
 
+class CorrectKwargs[T](ReviewKwargs[T], total=False):
+    """Arguments for content correction operations.
+
+    Extends GenerateKwargs with parameters for correcting content based on
+    specific criteria and templates.
+    """
+
+    reference: str
+    supervisor_check: bool
+
+
 # noinspection PyTypedDict
 class ChooseKwargs[T](ValidateKwargs[T], total=False):
     """Arguments for selection operations.

fabricatio-0.2.6.dev2.dist-info/METADATA

@@ -0,0 +1,432 @@
+Metadata-Version: 2.4
+Name: fabricatio
+Version: 0.2.6.dev2
+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: json-repair>=0.39.1
+Requires-Dist: litellm>=1.60.0
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: magika>=0.5.1
+Requires-Dist: more-itertools>=10.6.0
+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: 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, <3.13
+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
+
+![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)
+![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
+
+## Overview
+
+Fabricatio is a Python library designed for building LLM (Large Language Model) applications using an event-based agent structure. It integrates Rust for performance-critical tasks, utilizes Handlebars for templating, and employs PyO3 for Python bindings.
+
+## Features
+
+- **Event-Based Architecture**: Utilizes an EventEmitter pattern for robust task management.
+- **LLM Integration**: Supports interactions with large language models for intelligent task processing.
+- **Templating Engine**: Uses Handlebars for dynamic content generation.
+- **Toolboxes**: Provides predefined toolboxes for common operations like file manipulation and arithmetic.
+- **Async Support**: Fully asynchronous for efficient execution.
+- **Extensible**: Easy to extend with custom actions, workflows, and tools.
+
+## Installation
+
+### Using UV (Recommended)
+
+To install Fabricatio using `uv` (a package manager for Python):
+
+```bash
+# Install uv if not already installed
+pip install uv
+
+# Clone the repository
+git clone https://github.com/Whth/fabricatio.git
+cd fabricatio
+
+# Install the package in development mode with uv
+uv --with-editable . maturin develop --uv -r
+```
+
+### Building Distribution
+
+For production builds:
+
+```bash
+# Build distribution packages
+make bdist
+```
+
+This will generate distribution files in the `dist` directory.
+
+## Usage
+
+### Basic Example
+
+#### Simple Hello World Program
+
+```python
+import asyncio
+from fabricatio import Action, Role, Task, logger, WorkFlow
+from typing import Any
+
+class Hello(Action):
+    name: str = "hello"
+    output_key: str = "task_output"
+
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+
+async def main() -> None:
+    role = Role(
+        name="talker",
+        description="talker role",
+        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
+    )
+
+    task = Task(name="say hello", goals="say hello", description="say hello to the world")
+    result = await task.delegate()
+    logger.success(f"Result: {result}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Advanced Examples
+
+#### Simple Chat
+
+Demonstrates a basic chat application.
+
+```python
+"""Simple chat example."""
+import asyncio
+from fabricatio import Action, Role, Task, WorkFlow, logger
+from fabricatio.models.events import Event
+from questionary import text
+
+class Talk(Action):
+    """Action that says hello to the world."""
+
+    output_key: str = "task_output"
+
+    async def _execute(self, task_input: Task[str], **_) -> int:
+        counter = 0
+        try:
+            while True:
+                user_say = await text("User: ").ask_async()
+                gpt_say = await self.aask(
+                    user_say,
+                    system_message=f"You have to answer to user obeying task assigned to you:\n{task_input.briefing}",
+                )
+                print(f"GPT: {gpt_say}")  # noqa: T201
+                counter += 1
+        except KeyboardInterrupt:
+            logger.info(f"executed talk action {counter} times")
+        return counter
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="talker",
+        description="talker role",
+        registry={Event.instantiate_from("talk").push_wildcard().push("pending"): WorkFlow(name="talk", steps=(Talk,))},
+    )
+
+    task = await role.propose_task(
+        "you have to act as a helpful assistant, answer to all user questions properly and patiently"
+    )
+    _ = await task.delegate("talk")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+#### Simple RAG
+
+Demonstrates Retrieval-Augmented Generation (RAG).
+
+```python
+"""Simple chat example."""
+import asyncio
+from fabricatio import RAG, Action, Role, Task, WorkFlow, logger
+from fabricatio.models.events import Event
+from questionary import text
+
+class Talk(Action, RAG):
+    """Action that says hello to the world."""
+
+    output_key: str = "task_output"
+
+    async def _execute(self, task_input: Task[str], **_) -> int:
+        counter = 0
+
+        self.init_client().view("test_collection", create=True)
+        await self.consume_string(
+            [
+                "Company policy clearly stipulates that all employees must arrive at the headquarters building located at 88 Jianguo Road, Chaoyang District, Beijing before 9 AM daily.",
+                "According to the latest revised health and safety guidelines, employees must wear company-provided athletic gear when using the company gym facilities.",
+                "Section 3.2.1 of the employee handbook states that pets are not allowed in the office area under any circumstances.",
+                "To promote work efficiency, the company has quiet workspaces at 100 Century Avenue, Pudong New District, Shanghai, for employees who need high concentration for their work.",
+                "According to the company's remote work policy, employees can apply for a maximum of 5 days of working from home per month, but must submit the application one week in advance.",
+                "The company has strict regulations on overtime. Unless approved by direct supervisors, no form of work is allowed after 9 PM.",
+                "Regarding the new regulations for business travel reimbursement, all traveling personnel must submit detailed expense reports within five working days after returning.",
+                "Company address: 123 East Sports Road, Tianhe District, Guangzhou, Postal Code: 510620.",
+                "Annual team building activities will be held in the second quarter of each year, usually at a resort within a two-hour drive from the Guangzhou headquarters.",
+                "Employees who are late more than three times will receive a formal warning, which may affect their year-end performance evaluation.",
+            ]
+        )
+        try:
+            while True:
+                user_say = await text("User: ").ask_async()
+                if user_say is None:
+                    break
+                gpt_say = await self.aask_retrieved(
+                    user_say,
+                    user_say,
+                    extra_system_message=f"You have to answer to user obeying task assigned to you:\n{task_input.briefing}",
+                )
+                print(f"GPT: {gpt_say}")  # noqa: T201
+                counter += 1
+        except KeyboardInterrupt:
+            logger.info(f"executed talk action {counter} times")
+        return counter
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="talker",
+        description="talker role but with rag",
+        registry={Event.instantiate_from("talk").push_wildcard().push("pending"): WorkFlow(name="talk", steps=(Talk,))},
+    )
+
+    task = await role.propose_task(
+        "you have to act as a helpful assistant, answer to all user questions properly and patiently"
+    )
+    _ = await task.delegate("talk")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+#### Extract Article
+
+Demonstrates extracting the essence of an article from a file.
+
+```python
+"""Example of proposing a task to a role."""
+import asyncio
+from typing import List
+
+from fabricatio import ArticleEssence, Event, ExtractArticleEssence, Role, Task, WorkFlow, logger
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="Researcher",
+        description="Extract article essence",
+        registry={
+            Event.quick_instantiate("article"): WorkFlow(
+                name="extract",
+                steps=(ExtractArticleEssence(output_key="task_output"),),
+            )
+        },
+    )
+    task: Task[List[ArticleEssence]] = await role.propose_task(
+        "Extract the essence of the article from the file at './7.md'"
+    )
+    ess = (await task.delegate("article")).pop()
+    logger.success(f"Essence:\n{ess.display()}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+#### Propose Task
+
+Demonstrates proposing a task to a role.
+
+```python
+"""Example of proposing a task to a role."""
+import asyncio
+from typing import Any
+
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger
+
+class Talk(Action):
+    """Action that says hello to the world."""
+
+    output_key: str = "task_output"
+
+    async def _execute(self, **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="talker",
+        description="talker role",
+        registry={Event.quick_instantiate("talk"): WorkFlow(name="talk", steps=(Talk,))},
+    )
+    logger.info(f"Task example:\n{Task.formated_json_schema()}")
+    logger.info(f"proposed task: {await role.propose_task('write a rust clap cli that can download a html page')}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+#### Review
+
+Demonstrates reviewing code.
+
+```python
+"""Example of review usage."""
+import asyncio
+
+from fabricatio import Role, logger
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="Reviewer",
+        description="A role that reviews the code.",
+    )
+
+    code = await role.aask(
+        "write a cli app using rust with clap which can generate a basic manifest of a standard rust project, output code only,no extra explanation"
+    )
+
+    logger.success(f"Code: \n{code}")
+    res = await role.review_string(code, "If the cli app is of good design")
+    logger.success(f"Review: \n{res.display()}")
+    await res.supervisor_check()
+    logger.success(f"Review: \n{res.display()}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+#### Write Outline
+
+Demonstrates writing an outline for an article in Typst format.
+
+```python
+"""Example of using the library."""
+import asyncio
+
+from fabricatio import Event, Role, WriteOutlineWorkFlow, logger
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="Undergraduate Researcher",
+        description="Write an outline for an article in typst format.",
+        registry={Event.quick_instantiate(ns := "article"): WriteOutlineWorkFlow},
+    )
+
+    proposed_task = await role.propose_task(
+        "You need to read the `./article_briefing.txt` file and write an outline for the article in typst format. The outline should be saved in the `./out.typ` file.",
+    )
+    path = await proposed_task.delegate(ns)
+    logger.success(f"The outline is saved in:\n{path}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Configuration
+
+The configuration for Fabricatio is managed via environment variables or TOML files. The default configuration file (`config.toml`) can be overridden by specifying a custom path.
+
+Example `config.toml`:
+
+```toml
+[llm]
+api_endpoint = "https://api.openai.com"
+api_key = "your_openai_api_key"
+timeout = 300
+max_retries = 3
+model = "gpt-3.5-turbo"
+temperature = 1.0
+stop_sign = ["\n\n\n", "User:"]
+top_p = 0.35
+generation_count = 1
+stream = false
+max_tokens = 8192
+```
+
+## Development Setup
+
+To set up a development environment for Fabricatio:
+
+1. **Clone the Repository**:
+    ```bash
+    git clone https://github.com/Whth/fabricatio.git
+    cd fabricatio
+    ```
+
+2. **Install Dependencies**:
+    ```bash
+    uv --with-editable . maturin develop --uv -r
+    ```
+
+3. **Run Tests**:
+    ```bash
+    make test
+    ```
+
+4. **Build Documentation**:
+    ```bash
+    make docs
+    ```
+
+## Contributing
+
+Contributions are welcome! Please follow these guidelines when contributing:
+
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b feature/new-feature`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature/new-feature`).
+5. Create a new Pull Request.
+
+## License
+
+Fabricatio is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
+
+## Acknowledgments
+
+Special thanks to the contributors and maintainers of:
+- [PyO3](https://github.com/PyO3/pyo3)
+- [Maturin](https://github.com/PyO3/maturin)
+- [Handlebars.rs](https://github.com/sunng87/handlebars-rust)

{fabricatio-0.2.6.dev1.dist-info → fabricatio-0.2.6.dev2.dist-info}/RECORD

@@ -1,13 +1,13 @@
-fabricatio-0.2.6.dev1.dist-info/METADATA,sha256=EAsdhUegSLfBx_7NiZpY2BL54yfY1uHPUZmtoH_yaVU,8624
-fabricatio-0.2.6.dev1.dist-info/WHEEL,sha256=RIvmwLDYujv60MYBx2jxyP4vdn1DD7X0kBgz1TQvZuc,108
-fabricatio-0.2.6.dev1.dist-info/licenses/LICENSE,sha256=yDZaTLnOi03bi3Dk6f5IjhLUc5old2yOsihHWU0z-i0,1067
+fabricatio-0.2.6.dev2.dist-info/METADATA,sha256=Y6L-yF34GPs0csU6zdhZxzJ8OOsNxa26hT3iBaD7Jn8,13693
+fabricatio-0.2.6.dev2.dist-info/WHEEL,sha256=RIvmwLDYujv60MYBx2jxyP4vdn1DD7X0kBgz1TQvZuc,108
+fabricatio-0.2.6.dev2.dist-info/licenses/LICENSE,sha256=yDZaTLnOi03bi3Dk6f5IjhLUc5old2yOsihHWU0z-i0,1067
 fabricatio/decorators.py,sha256=cJHsxxbnMhc4SzPl4454CPLuDP3H0qbTrzV_U2rLPrs,6372
 fabricatio/core.py,sha256=MaEKZ6DDmbdScAY-7F1gwGA6fr7ADX6Mz5rNVi2msFA,6277
 fabricatio/models/generic.py,sha256=WxT4KBGGZTpqGPSPVwD5mkmhYBjxggZ7n-HKi-Hed4M,13619
 fabricatio/models/tool.py,sha256=ATwbOyvOTzrfAKcbOmCqdG3je4-T5jrM6FIw4cDPRDY,6863
 fabricatio/models/role.py,sha256=pQUHj5jx5OqbbDufhvoqqF72R0dJ6aIrREieASe96Ls,1794
 fabricatio/models/extra.py,sha256=ndK8EKzANT7sz_1f00PtJgs8922M9V3_G4JlORXySKk,7241
-fabricatio/models/kwargs_types.py,sha256=1i_R_FDElmRzBpNLBM8SuqzLt2aJSjjC9AS-NYUlWYg,4139
+fabricatio/models/kwargs_types.py,sha256=30hREqUXw4_0fVl6-NPdnTN07hSBiCWcdVr5z6RH6jE,4415
 fabricatio/models/utils.py,sha256=KmsTQcBCTYgnsZz7U1ECSfLRdswWPkKtGg8mBMaXrwA,4850
 fabricatio/models/usages.py,sha256=DiCiS1_YsHyB1-cQJdevyVxAn5_B9x0717mis8DNG9s,27952
 fabricatio/models/events.py,sha256=UvOc6V3vfjKuvh7irDezJ8EGpsNo5yzLdq4xQexVonw,4063
@@ -30,7 +30,7 @@ fabricatio/_rust_instances.py,sha256=bQmlhUCcxTmRgvw1SfzYzNNpgW_UCjmkYw5f-VPAyg8
 fabricatio/workflows/articles.py,sha256=utvKDBFEJbcM76729-H2AvgMCNcsX1NquqMpHqGZq8E,565
 fabricatio/workflows/rag.py,sha256=uOZXprD479fUhLA6sYvEM8RWcVcUZXXtP0xRbTMPdHE,509
 fabricatio/parser.py,sha256=uewTtO5N_5FAX_4rVzysGJsVs75J0vR-Iz7_dvWfGQk,6045
-fabricatio/capabilities/correct.py,sha256=s2vXPkX-NKBO5Yt1qaMDbrXfrYBRxzI5bvWBXnbaaOw,4424
+fabricatio/capabilities/correct.py,sha256=BiLEAk6e1KbwUMhTexmDfgtlPUct_bG0igDK7CwHqao,5107
 fabricatio/capabilities/rag.py,sha256=ghctqjIf6KDe6PP8-SDzKN1zxh94rXk5Y5hHFtG_46Y,15404
 fabricatio/capabilities/rating.py,sha256=ZQrKKmmIgnN4zgNnG_GmWa5Nyxpk03JYW32RJ4R5vvQ,14067
 fabricatio/capabilities/review.py,sha256=TX7av4b2N7MRDHMowsIZfiujXRRNxjUMNHtCFVA1UTM,10824
@@ -38,5 +38,5 @@ fabricatio/capabilities/propose.py,sha256=4QvONVVUp1rs34Te2Rjams6NioEt6FhEAxDWiv
 fabricatio/capabilities/task.py,sha256=uAp4tC9cbq3Ux-VQHjYdEzKLE3Jr8vhB6HKLPbhozIo,4494
 fabricatio/_rust.pyi,sha256=xXSaL7llihyFIyr9_k6e5RRJVNYk2jM-jrrheNvvaIA,3067
 fabricatio/_rust.cpython-312-x86_64-linux-gnu.so,sha256=74s_TC4HghV27dU5SlwPhHVbGQXAjB_tRTopjpIWjBI,1899904
-fabricatio-0.2.6.dev1.data/scripts/tdown,sha256=_ZohEMMAnhhlAKfxVua2YoN3LSsaWp1RVXCA6y1EBTg,4573488
-fabricatio-0.2.6.dev1.dist-info/RECORD,,
+fabricatio-0.2.6.dev2.data/scripts/tdown,sha256=_ZohEMMAnhhlAKfxVua2YoN3LSsaWp1RVXCA6y1EBTg,4573488
+fabricatio-0.2.6.dev2.dist-info/RECORD,,

fabricatio-0.2.6.dev1.dist-info/METADATA

@@ -1,312 +0,0 @@
-Metadata-Version: 2.4
-Name: fabricatio
-Version: 0.2.6.dev1
-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: json-repair>=0.39.1
-Requires-Dist: litellm>=1.60.0
-Requires-Dist: loguru>=0.7.3
-Requires-Dist: magika>=0.5.1
-Requires-Dist: more-itertools>=10.6.0
-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: 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, <3.13
-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
-
-![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)
-![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)
-![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
-
-## Overview
-
-Fabricatio is a Python library designed for building LLM (Large Language Model) applications using an event-based agent structure. It integrates Rust for performance-critical tasks, utilizes Handlebars for templating, and employs PyO3 for Python bindings.
-
-## Features
-
-- **Event-Based Architecture**: Utilizes an EventEmitter pattern for robust task management.
-- **LLM Integration**: Supports interactions with large language models for intelligent task processing.
-- **Templating Engine**: Uses Handlebars for dynamic content generation.
-- **Toolboxes**: Provides predefined toolboxes for common operations like file manipulation and arithmetic.
-- **Async Support**: Fully asynchronous for efficient execution.
-- **Extensible**: Easy to extend with custom actions, workflows, and tools.
-
-## Installation
-
-### Using UV (Recommended)
-
-To install Fabricatio using `uv` (a package manager for Python):
-
-```bash
-# Install uv if not already installed
-pip install uv
-
-# Clone the repository
-git clone https://github.com/Whth/fabricatio.git
-cd fabricatio
-
-# Install the package in development mode with uv
-uv --with-editable . maturin develop --uv -r
-```
-
-
-### Building Distribution
-
-For production builds:
-
-```bash
-# Build distribution packages
-make bdist
-```
-
-
-This will generate distribution files in the `dist` directory.
-
-## Usage
-
-### Basic Example
-
-#### Simple Hello World Program
-
-```python
-import asyncio
-from fabricatio import Action, Role, Task, logger, WorkFlow
-from typing import Any
-
-class Hello(Action):
-    name: str = "hello"
-    output_key: str = "task_output"
-
-    async def _execute(self, task_input: Task[str], **_) -> Any:
-        ret = "Hello fabricatio!"
-        logger.info("executing talk action")
-        return ret
-
-async def main() -> None:
-    role = Role(
-        name="talker",
-        description="talker role",
-        registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
-    )
-
-    task = Task(name="say hello", goals="say hello", description="say hello to the world")
-    result = await task.delegate()
-    logger.success(f"Result: {result}")
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-
-### Advanced Examples
-
-#### Writing and Dumping Code
-
-```python
-import asyncio
-from fabricatio import Action, Event, PythonCapture, Role, Task, ToolBox, WorkFlow, fs_toolbox, logger
-
-
-class WriteCode(Action):
-    name: str = "write code"
-    output_key: str = "source_code"
-
-    async def _execute(self, task_input: Task[str], **_) -> str:
-        return await self.aask_validate(task_input.briefing, validator=PythonCapture.capture)
-
-
-class DumpCode(Action):
-    name: str = "dump code"
-    description: str = "Dump code to file system"
-    toolboxes: set[ToolBox] = {fs_toolbox}
-    output_key: str = "task_output"
-
-    async def _execute(self, task_input: Task, source_code: str, **_) -> Any:
-        path = await self.handle_fin_grind(task_input, {"source_code": source_code})
-        return path[0] if path else None
-
-
-async def main() -> None:
-    role = Role(
-        name="Coder",
-        description="A python coder who can write and document code",
-        registry={
-            Event.instantiate_from("coding.*").push("pending"): WorkFlow(
-                name="write code", steps=(WriteCode, DumpCode)
-            )
-        }
-    )
-
-    prompt = "write a Python CLI app which prints 'hello world' n times with detailed Google-style docstring. Write the source code to `cli.py`."
-    proposed_task = await role.propose_task(prompt)
-    path = await proposed_task.move_to("coding").delegate()
-    logger.success(f"Code Path: {path}")
-
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-
-### Template Management and Rendering
-
-```python
-from fabricatio._rust_instances import TEMPLATE_MANAGER
-
-template_name = "claude-xml.hbs"
-data = {
-    "absolute_code_path": "/path/to/project",
-    "source_tree": "source tree content",
-    "files": [{"path": "file1.py", "code": "print('Hello')"}],
-}
-
-rendered_template = TEMPLATE_MANAGER.render_template(template_name, data)
-print(rendered_template)
-```
-
-
-### Handling Security Vulnerabilities
-
-```python
-from fabricatio.models.usages import ToolBoxUsage
-from fabricatio.models.task import Task
-
-toolbox_usage = ToolBoxUsage()
-
-async def handle_security_vulnerabilities():
-    task = Task(
-        name="Security Check",
-        goals=["Identify security vulnerabilities"],
-        description="Perform a thorough security review on the project.",
-        dependencies=["./src/main.py"]
-    )
-
-    vulnerabilities = await toolbox_usage.gather_tools_fine_grind(task)
-    for vulnerability in vulnerabilities:
-        print(f"Found vulnerability: {vulnerability.name}")
-```
-
-
-### Managing CTF Challenges
-
-```python
-import asyncio
-
-from fabricatio.models.usages import ToolBoxUsage
-from fabricatio.models.task import Task
-
-toolbox_usage = ToolBoxUsage()
-
-async def solve_ctf_challenge(challenge_name: str, challenge_description: str, files: list[str]):
-    task = Task(
-        name=challenge_name,
-        goals=[f"Solve {challenge_name} challenge"],
-        description=challenge_description,
-        dependencies=files
-    )
-
-    solution = await toolbox_usage.gather_tools_fine_grind(task)
-    print(f"Challenge Solved: {solution}")
-
-if __name__ == "__main__":
-    asyncio.run(
-        solve_ctf_challenge("Binary Exploitation", "CTF Binary Exploitation Challenge", ["./challenges/binary_exploit"]))
-```
-
-
-## Configuration
-
-The configuration for Fabricatio is managed via environment variables or TOML files. The default configuration file (`config.toml`) can be overridden by specifying a custom path.
-
-Example `config.toml`:
-
-```toml
-[llm]
-api_endpoint = "https://api.openai.com"
-api_key = "your_openai_api_key"
-timeout = 300
-max_retries = 3
-model = "gpt-3.5-turbo"
-temperature = 1.0
-stop_sign = ["\n\n\n", "User:"]
-top_p = 0.35
-generation_count = 1
-stream = false
-max_tokens = 8192
-```
-
-
-## Development Setup
-
-To set up a development environment for Fabricatio:
-
-1. **Clone the Repository**:
-   ```bash
-   git clone https://github.com/Whth/fabricatio.git
-   cd fabricatio
-   ```
-
-
-2. **Install Dependencies**:
-   ```bash
-   uv --with-editable . maturin develop --uv -r
-   ```
-
-
-3. **Run Tests**:
-   ```bash
-   make test
-   ```
-
-
-4. **Build Documentation**:
-   ```bash
-   make docs
-   ```
-
-
-## Contributing
-
-Contributions are welcome! Please follow these guidelines when contributing:
-
-1. Fork the repository.
-2. Create your feature branch (`git checkout -b feature/new-feature`).
-3. Commit your changes (`git commit -am 'Add new feature'`).
-4. Push to the branch (`git push origin feature/new-feature`).
-5. Create a new Pull Request.
-
-## License
-
-Fabricatio is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
-
-## Acknowledgments
-
-Special thanks to the contributors and maintainers of:
-- [PyO3](https://github.com/PyO3/pyo3)
-- [Maturin](https://github.com/PyO3/maturin)
-- [Handlebars.rs](https://github.com/sunng87/handlebars-rust)