fabricatio 0.2.6.dev2__cp312-cp312-win_amd64.whl → 0.2.7__cp312-cp312-win_amd64.whl

fabricatio-0.2.7.dist-info/RECORD

@@ -0,0 +1,47 @@
+fabricatio-0.2.7.dist-info/METADATA,sha256=pURYBzHBlC9kis-tB11uD9qVokoR9Kpj52synmR7sMs,5254
+fabricatio-0.2.7.dist-info/WHEEL,sha256=jABKVkLC9kJr8mi_er5jOqpiQUjARSLXDUIIxDqsS50,96
+fabricatio-0.2.7.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=W8MePeBrROpByxX48CKe4IwjRpm49-bnqM4V1SYThZk,8356
+fabricatio/actions/article_rag.py,sha256=PiOFxI6VTmLXm3BK-01g_KH1mTE9uOtnA-CwUjt16AU,1456
+fabricatio/actions/output.py,sha256=K7xsBH8MjXRH6JOy3ZO94KCQzX2jNrwPPK_rRXVkS0E,1161
+fabricatio/actions/rag.py,sha256=QBdzEM8MloM_ahx5pTBZAETm9_631lTe_0ih_he_Iuo,2759
+fabricatio/capabilities/correct.py,sha256=EM58d6Kt_XVpJFk9bkIbgBDA9LYTt6t5I0LPVuf_Fq8,6530
+fabricatio/capabilities/propose.py,sha256=y3kge5g6bb8HYuV8e9h4MdqOMTlsfAIZpqE_cagWPTY,1593
+fabricatio/capabilities/rag.py,sha256=XVvfH6rcog-moj1WCgwtR-l0-NdbFR6-fMQFLG7_asY,17690
+fabricatio/capabilities/rating.py,sha256=yEPqL5_DqVMj_AH9cMvKsHdMnSbvm8dN6PaKHLsJUPQ,14904
+fabricatio/capabilities/review.py,sha256=uc4WV9Xu-4rXAXZ-k-32HXAgm4WMLbDRfiZdRP7Nepg,11384
+fabricatio/capabilities/task.py,sha256=vtS0YOe639vN8iTrkP2WK0AJVCr5N_JAaJuvRGyY2Fg,4639
+fabricatio/config.py,sha256=hUv5XMzOkEw8cQjsVHTpPPix52IKwmxjBsZM6Px3xZI,16915
+fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
+fabricatio/decorators.py,sha256=C0Gi7wcXC-0sWITqsSv3JdBGcgVJOlRvOt0FfO0aUsA,7554
+fabricatio/fs/curd.py,sha256=N6l2MncjrFfnXBRtteRouXp5Rjy8EAKC_i29_G-zz98,4618
+fabricatio/fs/readers.py,sha256=EZKN_AZdrp8DggJECP53QHw3uHeSDf-AwCAA_V7fNKU,1202
+fabricatio/fs/__init__.py,sha256=PCf0s_9KDjVfNw7AfPoJzGt3jMq4gJOfbcT4pb0D0ZY,588
+fabricatio/journal.py,sha256=stnEP88aUBA_GmU9gfTF2EZI8FS2OyMLGaMSTgK4QgA,476
+fabricatio/models/action.py,sha256=UlflniS__MMrUXglu_U3PDFAtKEjVsKEix17AT9oP3M,8769
+fabricatio/models/events.py,sha256=QvlnS8FEELg6KNabcJMeh2GV_y0ZBzKOPphcteKYWYU,4183
+fabricatio/models/extra/article_base.py,sha256=kX32SvjUitK7fQr97joKyWlTpjqjrvsrWQVVqjggwkA,15371
+fabricatio/models/extra/article_essence.py,sha256=DUESuK4CGgkRvIMoJCv4l8MNp5MawRYoNOtLCrFRPXY,9229
+fabricatio/models/extra/article_main.py,sha256=XekZcXztjWdFT39lZ_Ny0zVGu56wt1oieeLd7aLPJo8,7400
+fabricatio/models/extra/article_outline.py,sha256=pIsO5bOSV-SUeWWdhkfkVpcr9RPOHgYmsceHsrXs67M,1145
+fabricatio/models/extra/article_proposal.py,sha256=p0NPzqg9x6t65DZqdF52Z1P0JwP6kwo2_eP-NsXgifU,1720
+fabricatio/models/generic.py,sha256=tVMitdYI6gK30eWAIFvfXSRWliTzcfMKvuhaKFcZ_xw,19004
+fabricatio/models/kwargs_types.py,sha256=chJ-rHaeBVRUPuORHuGR3DdNxxTUrotz0eflPEh4l4w,5474
+fabricatio/models/role.py,sha256=mmQbJ6GKr2Gx3wtjEz8d-vYoXs09ffcEkT_eCXaDd3E,2782
+fabricatio/models/task.py,sha256=8NaR7ojQWyM740EDTqt9stwHKdrD6axCRpLKo0QzS-I,10492
+fabricatio/models/tool.py,sha256=kD0eB7OxO9geZOxO6JIKvCBeG-KOpRAkfRZqK_WGfW4,7105
+fabricatio/models/usages.py,sha256=BSqTENSva8Flga3bPBfwuc1nHo5Z_29oYzar99NbjLM,31566
+fabricatio/models/utils.py,sha256=yjxPZ6N7QGpGwkI_Vb28Ud3EhkdlB-tyfGRHAZMcGxs,5872
+fabricatio/parser.py,sha256=9Jzw-yV6uKbFvf6sPna-XHdziVGVBZWvPctgX_6ODL8,6251
+fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
+fabricatio/toolboxes/fs.py,sha256=l4L1CVxJmjw9Ld2XUpIlWfV0_Fu_2Og6d3E13I-S4aE,736
+fabricatio/toolboxes/__init__.py,sha256=KBJi5OG_pExscdlM7Bnt_UF43j4I3Lv6G71kPVu4KQU,395
+fabricatio/workflows/articles.py,sha256=G5HGRr-DHuYuEcfhFdFAuDvTTJ9aSU_UQ2yYXEjTMtM,1047
+fabricatio/workflows/rag.py,sha256=-YYp2tlE9Vtfgpg6ROpu6QVO8j8yVSPa6yDzlN3qVxs,520
+fabricatio/_rust.pyi,sha256=dGTGV7viu3YAGl1cRKIWrdHPc1hlwk3_hbaDaswxdVo,3831
+fabricatio/_rust_instances.py,sha256=2GwF8aVfYNemRI2feBzH1CZfBGno-XJJE5imJokGEYw,314
+fabricatio/__init__.py,sha256=SzBYsRhZeL77jLtfJEjmoHOSwHwUGyvMATX6xfndLDM,1135
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=KSrEUEqHJLRXmr2uwDgmVVxBu_oGHsN68uvH2hm4vDs,1835008
+fabricatio-0.2.7.data/scripts/tdown.exe,sha256=6GgVuiuWQ_iaKcoswVvE8bS1pYvemvGfmKo0CZV2WmE,3399680
+fabricatio-0.2.7.dist-info/RECORD,,

{fabricatio-0.2.6.dev2.dist-info → fabricatio-0.2.7.dist-info}/WHEEL

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

fabricatio/models/extra.py

@@ -1,171 +0,0 @@
-"""Extra models for built-in actions."""
-
-from typing import List
-
-from fabricatio.models.generic import Base, Display, FinalizedDumpAble, PrepareVectorization, ProposedAble
-from pydantic import Field
-
-
-class Equation(Base):
-    """Structured representation of mathematical equations (including their physical or conceptual meanings)."""
-
-    description: str
-    """A concise explanation of the equation's meaning, purpose, and relevance in the context of the research."""
-
-    latex_code: str
-    """The LaTeX code used to represent the equation in a publication-ready format."""
-
-
-class Figure(Base):
-    """Structured representation of figures (including their academic significance and explanatory captions)."""
-
-    description: str
-    """A detailed explanation of the figure's content and its role in conveying key insights."""
-
-    figure_caption: str
-    """The caption accompanying the figure, summarizing its main points and academic value."""
-
-    figure_path: str
-    """The file path to the figure"""
-
-
-class Highlightings(Base):
-    """Structured representation of highlighted elements in an academic paper (including equations, algorithms, figures, and tables)."""
-
-    # Academic Achievements Showcase
-    highlighted_equations: List[Equation] = Field(default_factory=list)
-    """Core mathematical equations that represent breakthroughs in the field, accompanied by explanations of their physical or conceptual significance,Should always be in LaTeX format wrapped in $ or $$ signs."""
-
-    highlighted_algorithms: List[str] = Field(default_factory=list)
-    """Pseudocode for key algorithms, annotated to highlight innovative components."""
-
-    highlighted_figures: List[Figure] = Field(default_factory=list)
-    """Critical diagrams or illustrations, each accompanied by a caption explaining their academic importance."""
-
-    highlighted_tables: List[str] = Field(default_factory=list)
-    """Important data tables, annotated to indicate statistical significance or other notable findings."""
-
-
-class ArticleEssence(ProposedAble, Display, PrepareVectorization):
-    """Structured representation of the core elements of an academic paper(providing a comprehensive digital profile of the paper's essential information)."""
-
-    # Basic Metadata
-    title: str = Field(...)
-    """The full title of the paper, including any subtitles if applicable."""
-
-    authors: List[str]
-    """A list of the paper's authors, typically in the order of contribution."""
-
-    keywords: List[str]
-    """A list of keywords that summarize the paper's focus and facilitate indexing."""
-
-    publication_year: int
-    """The year in which the paper was published."""
-
-    # Core Content Elements
-    highlightings: Highlightings = Field(default_factory=Highlightings)
-    """A collection of highlighted elements in the paper, including equations, algorithms, figures, and tables."""
-
-    domain: List[str]
-    """The research domains or fields addressed by the paper (e.g., ['Natural Language Processing', 'Computer Vision'])."""
-
-    abstract: str = Field(...)
-    """A structured abstract that outlines the research problem, methodology, and conclusions in three distinct sections."""
-
-    core_contributions: List[str]
-    """Key academic contributions that distinguish the paper from prior work in the field."""
-
-    technical_novelty: List[str]
-    """Specific technical innovations introduced by the research, listed as individual points."""
-
-    # Academic Discussion Dimensions
-    research_problems: List[str]
-    """A clearly defined research question or problem addressed by the study."""
-
-    limitations: List[str]
-    """An analysis of the methodological or experimental limitations of the research."""
-
-    future_work: List[str]
-    """Suggestions for potential directions or topics for follow-up studies."""
-
-    impact_analysis: List[str]
-    """An assessment of the paper's potential influence on the development of the field."""
-
-    def _prepare_vectorization_inner(self) -> str:
-        return self.model_dump_json()
-
-
-class ArticleProposal(ProposedAble, Display):
-    """Structured representation of the proposal for an academic paper."""
-
-    title: str = Field(...)
-    """The proposed title of the paper."""
-
-    focused_problem: List[str] = Field(default_factory=list)
-    """The specific research problem or question that the paper aims to address."""
-    research_aim: List[str] = Field(default_factory=list)
-    """The main objective or goal of the research, outlining what the study aims to achieve."""
-    research_methods: List[str] = Field(default_factory=list)
-    """The methods used in the research, including the approach, techniques, and tools employed."""
-
-
-class ArticleSubsectionOutline(Base):
-    """Structured representation of the subsections of an academic paper."""
-
-    title: str = Field(...)
-    """The title of the subsection."""
-
-    description: str = Field(...)
-    """A brief description of the subsection's content should be, how it fits into the overall structure of the paper, and its significance in the context of the research."""
-
-
-class ArticleSectionOutline(Base):
-    """Structured representation of the sections of an academic paper."""
-
-    title: str = Field(...)
-    """The title of the section."""
-    description: str = Field(...)
-    """A brief description of the section's content should be, how it fits into the overall structure of the paper, and its significance in the context of the research."""
-    subsections: List[ArticleSubsectionOutline] = Field(default_factory=list)
-    """The subsections of the section, outlining their content and significance."""
-
-
-class ArticleChapterOutline(Base):
-    """Structured representation of the chapters of an academic paper."""
-
-    title: str = Field(...)
-    """The title of the chapter."""
-    description: str = Field(...)
-    """A brief description of the chapter's content should be, how it fits into the overall structure of the paper, and its significance in the context of the research."""
-    sections: List[ArticleSectionOutline] = Field(default_factory=list)
-    """The sections of the chapter, outlining their content and significance."""
-
-
-class ArticleOutline(ProposedAble, Display, FinalizedDumpAble):
-    """Structured representation of the outline for an academic paper."""
-
-    title: str = Field(...)
-    """The proposed title of the paper."""
-
-    prospect: str = Field(...)
-    """A brief description of the research problem or question that the paper aims to address manipulating methods or techniques"""
-
-    chapters: List[ArticleChapterOutline] = Field(default_factory=list)
-    """The chapters of the paper, outlining their content and significance."""
-
-    def finalized_dump(self) -> str:
-        """Finalized dump of the article outline.
-
-        Returns:
-            str: The finalized dump of the article outline.
-        """
-        lines: List[str] = []
-
-        for chapter in self.chapters:
-            lines.append(f"= {chapter.title}")
-            for section in chapter.sections:
-                lines.append(f"== {section.title}")
-                for subsection in section.subsections:
-                    lines.append(f"=== {subsection.title}")
-
-        return "\n\n".join(lines)

fabricatio-0.2.6.dev2.dist-info/METADATA

@@ -1,432 +0,0 @@
-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)