fabricatio 0.2.6.dev8__tar.gz → 0.2.7__tar.gz

{fabricatio-0.2.6.dev8 → fabricatio-0.2.7}/.gitignore

@@ -165,3 +165,4 @@ cython_debug/
 
 extra/scripts/*
 output/
+.vscode/

fabricatio-0.2.7/Makefile

@@ -0,0 +1,27 @@
+DIST:=dist
+DATA:=extra
+PY:=3.12
+
+
+all:bdist
+
+tools:
+	cargo build --all --bins -Z unstable-options --artifact-dir $(DATA)/scripts --release
+	mkdir -p $(DATA)/scripts
+	rm $(DATA)/scripts/*.pdb || true
+	rm $(DATA)/scripts/*.dwarf || true
+
+dev: tools
+	uvx -p $(PY) --project . maturin develop --uv -r
+
+bdist:clean tools
+	uvx -p $(PY) --project . maturin sdist -o $(DIST)
+	uvx -p $(PY) --project . maturin build  -r -o $(DIST)
+
+clean:
+	rm -rf $(DIST) $(DATA)
+
+publish:tools
+	uvx -p $(PY) --project . maturin publish --skip-existing
+	uvx -p $(PY) --project . maturin upload --skip-existing $(DIST)/*
+.PHONY: tools dev bdist clean publish

fabricatio-0.2.7/PKG-INFO

@@ -0,0 +1,181 @@
+Metadata-Version: 2.4
+Name: fabricatio
+Version: 0.2.7
+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[calc,plot,rag] ; extra == 'full'
+Requires-Dist: sympy>=1.13.3 ; extra == 'calc'
+Requires-Dist: matplotlib>=3.10.1 ; extra == 'plot'
+Provides-Extra: rag
+Provides-Extra: full
+Provides-Extra: calc
+Provides-Extra: plot
+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 streamlined Python library for building LLM applications using an event-based agent structure. It leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
+
+## Features
+
+- **Event-Driven Architecture**: Robust task management through an EventEmitter pattern.
+- **LLM Integration & Templating**: Seamlessly interact with large language models and dynamic content generation.
+- **Async & Extensible**: Fully asynchronous execution with easy extension via custom actions and workflows.
+
+## Installation
+
+### Using UV (Recommended)
+
+```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
+
+```bash
+# Build distribution packages
+make bdist
+```
+
+## Usage
+
+### Basic Example
+
+```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())
+```
+
+### Examples
+
+For various usage scenarios, refer to the following examples:
+- Simple Chat
+- Retrieval-Augmented Generation (RAG)
+- Article Extraction
+- Propose Task
+- Code Review
+- Write Outline
+
+_(For full example details, please check our detailed documentation, see [Examples](./examples))_
+
+## Configuration
+
+The configuration for Fabricatio is managed via environment variables or TOML files. For example:
+
+```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
+
+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
+    ```
+
+## Contributing
+
+Contributions are welcome! Follow these steps:
+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 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.7/README.md

@@ -0,0 +1,138 @@
+# 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 streamlined Python library for building LLM applications using an event-based agent structure. It leverages Rust for performance-critical tasks, Handlebars for templating, and PyO3 for Python bindings.
+
+## Features
+
+- **Event-Driven Architecture**: Robust task management through an EventEmitter pattern.
+- **LLM Integration & Templating**: Seamlessly interact with large language models and dynamic content generation.
+- **Async & Extensible**: Fully asynchronous execution with easy extension via custom actions and workflows.
+
+## Installation
+
+### Using UV (Recommended)
+
+```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
+
+```bash
+# Build distribution packages
+make bdist
+```
+
+## Usage
+
+### Basic Example
+
+```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())
+```
+
+### Examples
+
+For various usage scenarios, refer to the following examples:
+- Simple Chat
+- Retrieval-Augmented Generation (RAG)
+- Article Extraction
+- Propose Task
+- Code Review
+- Write Outline
+
+_(For full example details, please check our detailed documentation, see [Examples](./examples))_
+
+## Configuration
+
+The configuration for Fabricatio is managed via environment variables or TOML files. For example:
+
+```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
+
+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
+    ```
+
+## Contributing
+
+Contributions are welcome! Follow these steps:
+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 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.7/examples/extract_and_inject/article_rag.py

@@ -0,0 +1,33 @@
+"""Example of proposing a task to a role."""
+
+import asyncio
+
+from fabricatio import Event, Role, Task, WorkFlow, logger
+from fabricatio.actions.rag import RAGTalk
+
+
+async def main() -> None:
+    """Main function."""
+    role = Role(
+        name="Researcher",
+        description="Extract article essence",
+        llm_model="openai/deepseek-r1-distill-llama-70b",
+        llm_rpm=50,
+        llm_tpm=100000,
+        registry={
+            Event.quick_instantiate(e := "answer"): WorkFlow(
+                name="answer",
+                steps=(RAGTalk,),
+            ).update_init_context(collection_name="article_essence"),
+        },
+    )
+
+    task: Task[int] = await role.propose_task(
+        "Answer to all user questions properly and patiently",
+    )
+
+    logger.info(f"Complete {await task.delegate(e)} times qa.")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

fabricatio-0.2.7/examples/extract_and_inject/ask.py

@@ -0,0 +1,59 @@
+"""Simple chat example."""
+
+import asyncio
+
+from fabricatio import RAG, Action, Role, Task, WorkFlow, logger
+from fabricatio.models.events import Event
+from fabricatio.models.utils import ok
+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()
+
+        try:
+            while True:
+                user_say = await text("User: ").ask_async()
+                if user_say is None:
+                    break
+                gpt_say = await self.aask_refined(
+                    user_say,
+                    "article_essence_max",
+                    extra_system_message=f"You have to answer to user obeying task assigned to you:\n{task_input.briefing}\nYou should explicitly say write a label if you draw a conclusion from the references, the label shall contain names.",
+                    result_per_query=16,
+                    final_limit=40,
+                    similarity_threshold=0.31,
+                )
+                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 = ok(
+        await role.propose_task(
+            "you have to act as a helpful assistant, answer to all user questions properly and patiently"
+        ),
+        "Failed to propose task",
+    )
+    _ = await task.delegate("talk")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

{fabricatio-0.2.6.dev8 → fabricatio-0.2.7}/examples/extract_and_inject/extract_and_inject.py

@@ -8,7 +8,9 @@ from fabricatio import Action, Event, Role, Task, WorkFlow, logger
 from fabricatio.actions.article import ExtractArticleEssence
 from fabricatio.actions.rag import InjectToDB
 from fabricatio.fs.curd import dump_text, gather_files
-from fabricatio.models.extra import ArticleEssence
+from fabricatio.models.extra.article_essence import ArticleEssence
+from fabricatio.models.utils import ok
+from pydantic import HttpUrl
 
 
 class SaveToFS(Action):
@@ -31,20 +33,25 @@ async def main() -> None:
     role = Role(
         name="Researcher",
         description="Extract article essence",
-        llm_model="openai/deepseek-r1-distill-llama-70b",
-        llm_rpm=50,
-        llm_tpm=100000,
+        llm_api_endpoint=HttpUrl("https://dashscope.aliyuncs.com/compatible-mode/v1"),
+        llm_model="openai/qwq-plus",
+        llm_stream=True,
+        llm_rpm=500,
+        llm_tpm=5000000,
         registry={
             Event.quick_instantiate("article"): WorkFlow(
                 name="extract",
                 steps=(ExtractArticleEssence(output_key="to_inject"), SaveToFS, InjectToDB(output_key="task_output")),
-                extra_init_context={"collection_name": "article_essence", "output_dir": Path("output")},
+            ).update_init_context(
+                override_inject=True, collection_name="article_essence_max", output_dir=Path("output")
             )
         },
     )
 
-    task: Task[str] = await role.propose_task(
-        "Extract the essence of the article from the files in './bpdf_out'",
+    task: Task[str] = ok(
+        await role.propose_task(
+            "Extract the essence of the article from the files in './bpdf_out'",
+        )
     )
 
     col_name = await task.override_dependencies(gather_files("bpdf_out", "md")).delegate("article")

{fabricatio-0.2.6.dev8 → fabricatio-0.2.7}/examples/extract_article/extract.py

@@ -7,7 +7,7 @@ from fabricatio import Event, Role, Task, WorkFlow, logger
 from fabricatio.actions.article import ExtractArticleEssence
 
 if TYPE_CHECKING:
-    from fabricatio.models.extra import ArticleEssence
+    from fabricatio.models.extra.article_essence import ArticleEssence
 
 
 async def main() -> None:

fabricatio-0.2.7/examples/write_article/write_article.py

@@ -0,0 +1,46 @@
+"""Example of using the library."""
+
+import asyncio
+from pathlib import Path
+
+from fabricatio import Event, Role, WorkFlow, logger
+from fabricatio.actions.article import (
+    GenerateArticle,
+    GenerateArticleProposal,
+    GenerateOutline,
+)
+from fabricatio.actions.output import DumpFinalizedOutput
+from fabricatio.models.task import Task
+
+
+async def main() -> None:
+    """Main function."""
+    Role(
+        name="Undergraduate Researcher",
+        description="Write an outline for an article in typst format.",
+        llm_top_p=0.8,
+        llm_temperature=1.15,
+        llm_max_tokens=8192,
+        llm_model="openai/qwen-max",
+        llm_stream=True,
+        registry={
+            Event.quick_instantiate(ns := "article"): WorkFlow(
+                name="Generate Article Outline",
+                description="Generate an outline for an article. dump the outline to the given path. in typst format.",
+                steps=(
+                    GenerateArticleProposal(llm_temperature=1.18),
+                    GenerateOutline(llm_temperature=1.21, llm_top_p=0.3),
+                    GenerateArticle(output_key="to_dump", llm_temperature=1.2, llm_top_p=0.45),
+                    DumpFinalizedOutput(output_key="task_output"),
+                ),
+            ).update_init_context(article_briefing=Path("./article_briefing.txt").read_text(), dump_path="out.typ")
+        },
+    )
+
+    proposed_task = Task(name="write an article")
+    path = await proposed_task.delegate(ns)
+    logger.success(f"The outline is saved in:\n{path}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

fabricatio-0.2.7/examples/write_outline/.gitignore

@@ -0,0 +1,2 @@
+article_briefing.txt
+out.typ

{fabricatio-0.2.6.dev8 → fabricatio-0.2.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fabricatio"
-version = "0.2.6-dev8"
+version = "0.2.7"
 description = "A LLM multi-agent framework."
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -81,7 +81,13 @@ rag = [
 ]
 
 full = [
-    "fabricatio[rag]",
+    "fabricatio[calc,plot,rag]",
+]
+calc = [
+    "sympy>=1.13.3",
+]
+plot = [
+    "matplotlib>=3.10.1",
 ]
 
 [tool.ruff]
@@ -140,6 +146,9 @@ testpaths = [
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"
 
+[tool.uv.sources]
+fabricatio = { workspace = true }
+
 [[tool.uv.index]]
 url = "https://mirrors.bfsu.edu.cn/pypi/web/simple"
 default = true

{fabricatio-0.2.6.dev8 → fabricatio-0.2.7}/python/fabricatio/_rust.pyi

@@ -11,7 +11,7 @@ class TemplateManager:
     """
 
     def __init__(
-            self, template_dirs: List[Path], suffix: Optional[str] = None, active_loading: Optional[bool] = None
+        self, template_dirs: List[Path], suffix: Optional[str] = None, active_loading: Optional[bool] = None
     ) -> None:
         """Initialize the template manager.
 
@@ -55,6 +55,16 @@ class TemplateManager:
             RuntimeError: If template rendering fails
         """
 
+    def render_template_raw(self, template: str, data: Dict[str, Any]) -> str:
+        """Render a template with context data.
+
+        Args:
+            template: The template string
+            data: Context dictionary to provide variables to the template
+
+        Returns:
+            Rendered template content as string
+        """
 
 def blake3_hash(content: bytes) -> str:
     """Calculate the BLAKE3 cryptographic hash of data.
@@ -66,7 +76,6 @@ def blake3_hash(content: bytes) -> str:
         Hex-encoded BLAKE3 hash string
     """
 
-
 class BibManager:
     """BibTeX bibliography manager for parsing and querying citation data."""