fabricatio 0.9.5.dev3__cp312-cp312-macosx_11_0_arm64.whl

fabricatio/__init__.py

@@ -0,0 +1,22 @@
+"""Fabricatio is a Python library for building llm app using event-based agent structure."""
+
+from fabricatio_core import fs, parser, utils
+from fabricatio_core.journal import logger
+from fabricatio_core.models.action import Action, WorkFlow
+from fabricatio_core.models.role import Role
+from fabricatio_core.models.task import Task
+from fabricatio_core.rust import CONFIG, TEMPLATE_MANAGER, Event
+
+__all__ = [
+    "CONFIG",
+    "TEMPLATE_MANAGER",
+    "Action",
+    "Event",
+    "Role",
+    "Task",
+    "WorkFlow",
+    "fs",
+    "logger",
+    "parser",
+    "utils",
+]

fabricatio/actions/__init__.py

@@ -0,0 +1,74 @@
+"""This is the initialization file for the 'fabricatio.actions' package.
+
+It imports various action classes from different modules based on the availability of certain packages.
+The imported classes are then added to the '__all__' list, making them accessible when the package is imported.
+"""
+
+from importlib.util import find_spec
+
+__all__ = []
+
+if find_spec("fabricatio_typst"):
+    from fabricatio_typst.actions.article import (
+        ExtractArticleEssence,
+        ExtractOutlineFromRaw,
+        FixArticleEssence,
+        GenerateArticle,
+        GenerateArticleProposal,
+        GenerateInitialOutline,
+        WriteChapterSummary,
+        WriteResearchContentSummary,
+    )
+
+    __all__ += [
+        "ExtractArticleEssence",
+        "ExtractOutlineFromRaw",
+        "FixArticleEssence",
+        "GenerateArticle",
+        "GenerateArticleProposal",
+        "GenerateInitialOutline",
+        "WriteChapterSummary",
+        "WriteResearchContentSummary",
+    ]
+
+    if find_spec("fabricatio_rag"):
+        from fabricatio_typst.actions.article_rag import (
+            ArticleConsultRAG,
+            ChunkArticle,
+            TweakArticleRAG,
+            WriteArticleContentRAG,
+        )
+
+        __all__ += ["ArticleConsultRAG", "ChunkArticle", "TweakArticleRAG", "WriteArticleContentRAG"]
+if find_spec("fabricatio_rag"):
+    from fabricatio_rag.actions.rag import InjectToDB, RAGTalk
+
+    __all__ += ["InjectToDB", "RAGTalk"]
+
+if find_spec("fabricatio_actions"):
+    from fabricatio_actions.actions.fs import ReadText
+    from fabricatio_actions.actions.output import (
+        DumpFinalizedOutput,
+        Forward,
+        GatherAsList,
+        PersistentAll,
+        RenderedDump,
+        RetrieveFromLatest,
+        RetrieveFromPersistent,
+    )
+
+    __all__ += [
+        "DumpFinalizedOutput",
+        "Forward",
+        "GatherAsList",
+        "PersistentAll",
+        "ReadText",
+        "RenderedDump",
+        "RetrieveFromLatest",
+        "RetrieveFromPersistent",
+    ]
+
+if find_spec("fabricatio_yue"):
+    from fabricatio_yue.actions.compose import Compose
+
+    __all__ += ["Compose"]

fabricatio/capabilities/__init__.py

@@ -0,0 +1,78 @@
+"""A module containing all the capabilities of the Fabricatio framework."""
+
+from importlib.util import find_spec
+
+from fabricatio_core.capabilities.usages import UseEmbedding, UseLLM
+
+__all__ = ["UseEmbedding", "UseLLM"]
+
+if find_spec("fabricatio_tool"):
+    from fabricatio_tool.capabilities.handle import Handle
+    from fabricatio_tool.capabilities.handle_task import HandleTask
+    from fabricatio_tool.capabilities.use_tool import UseTool
+
+    __all__ += ["Handle", "HandleTask", "UseTool"]
+
+
+if find_spec("fabricatio_capabilities"):
+    from fabricatio_capabilities.capabilities.extract import Extract
+    from fabricatio_capabilities.capabilities.rating import Rating
+    from fabricatio_capabilities.capabilities.task import DispatchTask, ProposeTask
+    from fabricatio_core.capabilities.propose import Propose
+
+    __all__ += ["DispatchTask", "Extract", "HandleTask", "Propose", "ProposeTask", "Rating"]
+
+if find_spec("fabricatio_rag"):
+    from fabricatio_rag.capabilities.rag import RAG
+
+    __all__ += ["RAG"]
+    if find_spec("fabricatio_write"):
+        from fabricatio_typst.capabilities.citation_rag import CitationRAG
+
+    __all__ += ["CitationRAG"]
+
+if find_spec("fabricatio_rule"):
+    from fabricatio_rule.capabilities.censor import Censor
+    from fabricatio_rule.capabilities.check import Check
+
+    __all__ += ["Censor", "Check"]
+
+if find_spec("fabricatio_improve"):
+    from fabricatio_improve.capabilities.correct import Correct
+    from fabricatio_improve.capabilities.review import Review
+
+    __all__ += ["Correct", "Review"]
+
+if find_spec("fabricatio_judge"):
+    from fabricatio_judge.capabilities.advanced_judge import AdvancedJudge
+
+    __all__ += ["AdvancedJudge"]
+
+if find_spec("fabricatio_digest"):
+    from fabricatio_digest.capabilities.digest import Digest
+
+    __all__ += ["Digest"]
+
+if find_spec("fabricatio_anki"):
+    from fabricatio_anki.capabilities.generate_deck import GenerateDeck
+
+    __all__ += ["GenerateDeck"]
+
+if find_spec("fabricatio_tagging"):
+    from fabricatio_tagging.capabilities.tagging import Tagging
+
+    __all__ += ["Tagging"]
+if find_spec("fabricatio_question"):
+    from fabricatio_question.capabilities.questioning import Questioning
+
+    __all__ += ["Questioning"]
+
+if find_spec("fabricatio_yue"):
+    from fabricatio_yue.capabilities.genre import SelectGenre
+    from fabricatio_yue.capabilities.lyricize import Lyricize
+
+    __all__ += ["Lyricize", "SelectGenre"]
+if find_spec("fabricatio_memory"):
+    from fabricatio_memory.capabilities.memory import Remember
+
+    __all__ += ["Remember"]

fabricatio/models/__init__.py

@@ -0,0 +1,56 @@
+"""A module for the usage of the fabricatio package."""
+
+from importlib.util import find_spec
+
+__all__ = []
+
+if find_spec("fabricatio_typst"):
+    from fabricatio_typst.models.article_essence import ArticleEssence
+    from fabricatio_typst.models.article_main import Article
+    from fabricatio_typst.models.article_outline import ArticleOutline
+    from fabricatio_typst.models.article_proposal import ArticleProposal
+
+    __all__ += [
+        "Article",
+        "ArticleEssence",
+        "ArticleOutline",
+        "ArticleProposal",
+    ]
+
+    if find_spec("fabricatio_typst"):
+        from fabricatio_typst.models.aricle_rag import ArticleChunk
+
+        __all__ += ["ArticleChunk"]
+
+if find_spec("fabricatio_judge"):
+    from fabricatio_judge.models.judgement import JudgeMent
+
+    __all__ += ["JudgeMent"]
+
+if find_spec("fabricatio_digest"):
+    from fabricatio_digest.models.tasklist import TaskList
+
+    __all__ += ["TaskList"]
+
+
+if find_spec("fabricatio_anki"):
+    from fabricatio_anki.models.deck import Deck, Model
+    from fabricatio_anki.models.template import Template
+
+    __all__ += ["Deck", "Model", "Template"]
+
+if find_spec("fabricatio_question"):
+    from fabricatio_question.models.questions import SelectionQuestion
+
+    __all__ += ["SelectionQuestion"]
+
+
+if find_spec("fabricatio_yue"):
+    from fabricatio_yue.models.segment import Segment, Song
+
+    __all__ += ["Segment", "Song"]
+
+if find_spec("fabricatio_memory"):
+    from fabricatio_memory.models.note import Note
+
+    __all__ += ["Note"]

fabricatio/workflows/__init__.py

@@ -0,0 +1,10 @@
+"""A module containing some builtin workflows."""
+
+__all__ = []
+
+from importlib.util import find_spec
+
+if find_spec("fabricatio_typst") and find_spec("fabricatio_actions"):
+    from fabricatio_typst.workflows.articles import WriteOutlineCorrectedWorkFlow
+
+    __all__ += ["WriteOutlineCorrectedWorkFlow"]

fabricatio-0.9.5.dev3.dist-info/METADATA

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: fabricatio
+Version: 0.9.5.dev3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Pydantic :: 2
+Classifier: Typing :: Typed
+Requires-Dist: fabricatio-core
+Requires-Dist: fabricatio[rag,cli,typst,rule,judge,capabilities,actions,improve,digest,memory,anki,question,tagging,improve,rag,yue,tool] ; extra == 'full'
+Requires-Dist: fabricatio-anki ; extra == 'anki'
+Requires-Dist: fabricatio-memory ; extra == 'memory'
+Requires-Dist: fabricatio-digest ; extra == 'digest'
+Requires-Dist: fabricatio-rag ; extra == 'rag'
+Requires-Dist: fabricatio-judge ; extra == 'judge'
+Requires-Dist: fabricatio-rule ; extra == 'rule'
+Requires-Dist: typer-slim[standard]>=0.15.2 ; extra == 'cli'
+Requires-Dist: fabricatio-typst ; extra == 'typst'
+Requires-Dist: fabricatio-improve ; extra == 'improve'
+Requires-Dist: fabricatio-capabilities ; extra == 'capabilities'
+Requires-Dist: fabricatio-actions ; extra == 'actions'
+Requires-Dist: fabricatio-question ; extra == 'question'
+Requires-Dist: fabricatio-tagging ; extra == 'tagging'
+Requires-Dist: fabricatio-yue ; extra == 'yue'
+Requires-Dist: fabricatio-tool ; extra == 'tool'
+Provides-Extra: full
+Provides-Extra: anki
+Provides-Extra: memory
+Provides-Extra: digest
+Provides-Extra: rag
+Provides-Extra: judge
+Provides-Extra: rule
+Provides-Extra: cli
+Provides-Extra: typst
+Provides-Extra: improve
+Provides-Extra: capabilities
+Provides-Extra: actions
+Provides-Extra: question
+Provides-Extra: tagging
+Provides-Extra: yue
+Provides-Extra: tool
+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.14
+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
+
+<p align="center">   
+<picture>
+        <img src="./assets/band.png" width="80%" alt="Fabricatio Logo" loading="lazy">
+</picture>
+</p>
+
+
+
+
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Python Versions](https://img.shields.io/pypi/pyversions/fabricatio)](https://pypi.org/project/fabricatio/)
+[![PyPI Version](https://img.shields.io/pypi/v/fabricatio)](https://pypi.org/project/fabricatio/)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Whth/fabricatio)
+[![PyPI Downloads](https://static.pepy.tech/badge/fabricatio/week)](https://pepy.tech/projects/fabricatio)
+[![PyPI Downloads](https://static.pepy.tech/badge/fabricatio)](https://pepy.tech/projects/fabricatio)
+[![Bindings: PyO3](https://img.shields.io/badge/bindings-pyo3-green)](https://github.com/PyO3/pyo3)
+[![Powered by LiteLLM](https://img.shields.io/badge/Powered%20by-LiteLLM-blue)](https://github.com/BerriAI/litellm)
+[![Build Tool: uv + maturin](https://img.shields.io/badge/built%20with-uv%20%2B%20maturin-orange)](https://github.com/astral-sh/uv)
+[![Documentation Status](https://readthedocs.org/projects/fabricatio/badge/?version=latest)](https://fabricatio.readthedocs.io/en/latest/?badge=fabricatio)
+[![Build Package](https://github.com/Whth/fabricatio/actions/workflows/build-package.yaml/badge.svg)](https://github.com/Whth/fabricatio/actions/workflows/build-package.yaml)
+[![Ruff Lint](https://github.com/Whth/fabricatio/actions/workflows/ruff.yaml/badge.svg)](https://github.com/Whth/fabricatio/actions/workflows/ruff.yaml)
+[![Tests](https://github.com/Whth/fabricatio/actions/workflows/tests.yaml/badge.svg)](https://github.com/Whth/fabricatio/actions/workflows/tests.yaml)
+[![Coverage Status](https://coveralls.io/repos/github/Whth/fabricatio/badge.svg?branch=master)](https://coveralls.io/github/Whth/fabricatio?branch=master)
+![GitHub Issues](https://img.shields.io/github/issues/Whth/fabricatio)
+![GitHub Pull Requests](https://img.shields.io/github/issues-pr/Whth/fabricatio)
+![GitHub Stars](https://img.shields.io/github/stars/Whth/fabricatio)
+---
+
+## 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 uvx
+uvx --with-editable . maturin develop --uv -r
+
+# Or, with make
+make dev
+```
+
+### Building Distribution
+
+```bash
+# Build distribution packages
+make bdist
+```
+
+## Usage
+
+### Basic Example
+
+```python
+"""Example of a simple hello world program using fabricatio."""
+
+from typing import Any
+
+from fabricatio import Action, Event, Role, Task, WorkFlow, logger
+
+
+class Hello(Action):
+    """Action that says hello."""
+
+    output_key: str = "task_output"
+
+    async def _execute(self, **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+
+    """Main function."""
+
+
+(Role()
+ .register_workflow(Event.quick_instantiate("talk"), WorkFlow(name="talk", steps=(Hello,)))
+ .dispatch())
+
+assert Task(name="say hello").delegate_blocking("talk") == "Hello fabricatio!"
+
+```
+
+### 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
+    make dev
+    ```
+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)
+- [LiteLLM](https://github.com/BerriAI/litellm)
+

fabricatio-0.9.5.dev3.dist-info/RECORD

@@ -0,0 +1,12 @@
+fabricatio-0.9.5.dev3.data/scripts/tdown,sha256=oyON2TCFUjPwot7Le8ScegWic9OEUg80-rvKr9rK4GA,4337376
+fabricatio-0.9.5.dev3.dist-info/METADATA,sha256=N5RjbQJk32YfGflNdc71s10GKidipP84h8UPRqhqtoE,7517
+fabricatio-0.9.5.dev3.dist-info/WHEEL,sha256=vahFoO0M6DZmYz1cr_3GC_BJXbjcSJJ4jR_JC04LGJc,104
+fabricatio-0.9.5.dev3.dist-info/licenses/LICENSE,sha256=yDZaTLnOi03bi3Dk6f5IjhLUc5old2yOsihHWU0z-i0,1067
+fabricatio/__init__.py,sha256=4a_7gabZhl9dzonBxcF-8peCGTLNxYJSDfInf1VhRsY,568
+fabricatio/actions/__init__.py,sha256=4xR1wiPq2HPnVABXy6R3wOxcg9LZKD7g-h9IdTcNKvY,2106
+fabricatio/capabilities/__init__.py,sha256=_OA0cO2z1B2U_4Y7vSETf8_o1WJH5W-zy4yzUpGonMk,2562
+fabricatio/models/__init__.py,sha256=-T9QeEjg-Qyz-BofvLdpCDvd0ut9k6H0r25sIHMqDCI,1517
+fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/rust.cpython-312-darwin.so,sha256=C8uPaJAe2M7YNdJqNliy4NqDtIeweluV7QpYwzsAk9U,454688
+fabricatio/workflows/__init__.py,sha256=sr-0tgpNPdN5t2pDQa-gp-KUE7K0QDtjP9QGvWYLZ9A,305
+fabricatio-0.9.5.dev3.dist-info/RECORD,,

fabricatio-0.9.5.dev3.dist-info/WHEEL

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

fabricatio-0.9.5.dev3.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.