fabricatio 0.2.3.dev2__cp312-cp312-win_amd64.whl → 0.2.4.dev0__cp312-cp312-win_amd64.whl

{fabricatio-0.2.3.dev2.dist-info → fabricatio-0.2.4.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.2.3.dev2
+Version: 0.2.4.dev0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3.12
@@ -11,7 +11,6 @@ Classifier: Typing :: Typed
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: asyncio>=3.4.3
 Requires-Dist: asyncstdlib>=3.13.0
-Requires-Dist: gitpython>=3.1.44
 Requires-Dist: litellm>=1.60.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: magika>=0.5.1
@@ -37,13 +36,14 @@ 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
@@ -73,6 +73,7 @@ cd fabricatio
 uv --with-editable . maturin develop --uv -r
 ```
 
+
 ### Building Distribution
 
 For production builds:
@@ -82,24 +83,21 @@ For production builds:
 make bdist
 ```
 
+
 This will generate distribution files in the `dist` directory.
 
 ## Usage
 
 ### Basic Example
 
-Below are some basic examples demonstrating how to use Fabricatio for different purposes.
-
 #### Simple Hello World Program
 
 ```python
 import asyncio
-from fabricatio import Action, Role, Task, logger
-
+from fabricatio import Action, Role, Task, logger, WorkFlow
+from typing import Any
 
 class Hello(Action):
-    """Action that says hello."""
-
     name: str = "hello"
     output_key: str = "task_output"
 
@@ -108,24 +106,24 @@ class Hello(Action):
         logger.info("executing talk action")
         return ret
 
-
 async def main() -> None:
-    """Main function."""
     role = Role(
-        name="talker", 
-        description="talker role", 
+        name="talker",
+        description="talker role",
         registry={Task.pending_label: WorkFlow(name="talk", steps=(Hello,))}
     )
 
-    task = Task(name="say hello", goal="say hello", description="say hello to the world")
+    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
@@ -134,21 +132,14 @@ from fabricatio import Action, Event, PythonCapture, Role, Task, ToolBox, WorkFl
 
 
 class WriteCode(Action):
-    """Action that writes code based on a prompt."""
-
     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,
-        )
+        return await self.aask_validate(task_input.briefing, validator=PythonCapture.capture)
 
 
 class DumpCode(Action):
-    """Action that dumps code to the file system."""
-
     name: str = "dump code"
     description: str = "Dump code to file system"
     toolboxes: set[ToolBox] = {fs_toolbox}
@@ -160,20 +151,18 @@ class DumpCode(Action):
 
 
 async def main() -> None:
-    """Main function."""
     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(prompt)
+    proposed_task = await role.propose_task(prompt)
     path = await proposed_task.move_to("coding").delegate()
     logger.success(f"Code Path: {path}")
 
@@ -182,112 +171,8 @@ if __name__ == "__main__":
     asyncio.run(main())
 ```
 
-#### Proposing Tasks
-
-```python
-import asyncio
-from typing import Any
-
-from fabricatio import Action, Role, Task, WorkFlow, logger
-
-
-class WriteDocumentation(Action):
-    """Action that generates documentation for the code in markdown format."""
-
-    name: str = "write documentation"
-    description: str = "Write detailed documentation for the provided code."
-    output_key: str = "task_output"
-
-    async def _execute(self, task_input: Task[str], **_) -> str:
-        return await self.aask(task_input.briefing)
-
-
-async def main() -> None:
-    """Main function."""
-    role = Role(
-        name="Documenter",
-        description="Role responsible for writing documentation.",
-        registry={
-            "doc.*": WorkFlow(name="write documentation", steps=(WriteDocumentation,))
-        }
-    )
-
-    prompt = "write a Rust clap CLI that downloads an HTML page"
-    proposed_task = await role.propose(prompt)
-    documentation = await proposed_task.move_to("doc").delegate()
-    logger.success(f"Documentation:\n{documentation}")
-
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-#### Complex Workflow Handling
-
-```python
-import asyncio
-from fabricatio import Action, Event, Role, Task, WorkFlow, logger
-
-
-class WriteCode(Action):
-    """Action that writes code based on a prompt."""
-
-    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 WriteDocumentation(Action):
-    """Action that generates documentation for the code in markdown format."""
-
-    name: str = "write documentation"
-    description: str = "Write detailed documentation for the provided code."
-    output_key: str = "task_output"
-
-    async def _execute(self, task_input: Task[str], **_) -> str:
-        return await self.aask(task_input.briefing)
-
-
-async def main() -> None:
-    """Main function."""
-    role = Role(
-        name="Developer",
-        description="A developer who can write code and documentation.",
-        registry={
-            Event.instantiate_from("coding.*").push("pending"): WorkFlow(
-                name="write code", steps=(WriteCode,)
-            ),
-            Event.instantiate_from("doc.*").push("pending"): WorkFlow(
-                name="write documentation", steps=(WriteDocumentation,)
-            ),
-        }
-    )
-
-    # Propose a coding task
-    code_task_prompt = "write a Python CLI app which adds numbers from a file."
-    proposed_task = await role.propose(code_task_prompt)
-    code = await proposed_task.move_to("coding").delegate()
-    logger.success(f"Code:\n{code}")
-
-    # Propose a documentation task
-    doc_task_prompt = f"{code}\n\nwrite Readme.md file for the above code."
-    proposed_doc_task = await role.propose(doc_task_prompt)
-    documentation = await proposed_doc_task.move_to("doc").delegate()
-    logger.success(f"Documentation:\n{documentation}")
-
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-### Advanced Examples
 
-#### Template Management and Rendering
+### Template Management and Rendering
 
 ```python
 from fabricatio._rust_instances import template_manager
@@ -303,7 +188,8 @@ rendered_template = template_manager.render_template(template_name, data)
 print(rendered_template)
 ```
 
-#### Handling Security Vulnerabilities
+
+### Handling Security Vulnerabilities
 
 ```python
 from fabricatio.models.usages import ToolBoxUsage
@@ -314,17 +200,18 @@ toolbox_usage = ToolBoxUsage()
 async def handle_security_vulnerabilities():
     task = Task(
         name="Security Check",
-        goal=["Identify security vulnerabilities"],
+        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
+
+### Managing CTF Challenges
 
 ```python
 import asyncio
@@ -337,19 +224,21 @@ toolbox_usage = ToolBoxUsage()
 async def solve_ctf_challenge(challenge_name: str, challenge_description: str, files: list[str]):
     task = Task(
         name=challenge_name,
-        goal=[f"Solve {challenge_name} challenge"],
+        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"]))
+    asyncio.run(
+        solve_ctf_challenge("Binary Exploitation", "CTF Binary Exploitation Challenge", ["./challenges/binary_exploit"]))
 ```
 
-### Configuration
+
+## 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.
 
@@ -370,7 +259,8 @@ stream = false
 max_tokens = 8192
 ```
 
-### Development Setup
+
+## Development Setup
 
 To set up a development environment for Fabricatio:
 
@@ -380,22 +270,26 @@ To set up a development environment for Fabricatio:
    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
+
+## Contributing
 
 Contributions are welcome! Please follow these guidelines when contributing:
 
@@ -405,15 +299,13 @@ Contributions are welcome! Please follow these guidelines when contributing:
 4. Push to the branch (`git push origin feature/new-feature`).
 5. Create a new Pull Request.
 
-### License
+## License
 
 Fabricatio is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
 
-### Acknowledgments
+## 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)
-
-
+- [Handlebars.rs](https://github.com/sunng87/handlebars-rust)

fabricatio-0.2.4.dev0.dist-info/RECORD

@@ -0,0 +1,37 @@
+fabricatio-0.2.4.dev0.dist-info/METADATA,sha256=1sPsuFY-rBXRPE-zNVr6RXMNQ_f9q0idfNN3aUVG6Tw,8861
+fabricatio-0.2.4.dev0.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
+fabricatio-0.2.4.dev0.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
+fabricatio/actions/article.py,sha256=WEKGqSx7tAhCMB0ziHVlDIYQywnUAH0R_Ha49xuJSdY,5483
+fabricatio/actions/__init__.py,sha256=CjlbRaRqqKWPxqZEtk7tQt3Mul17CY9O4alo6VjWGNk,130
+fabricatio/capabilities/propose.py,sha256=nahXjB6_nP0Fru880oh_9oINrjrL0Qs-SLHA-d3CFUE,1769
+fabricatio/capabilities/rag.py,sha256=paq2zUOfw6whIBFkKDo1Kg5Ft5YXgWiJBNKq-6uGhuU,13295
+fabricatio/capabilities/rating.py,sha256=zmTUvsUfxFgovRQzy4djL2zKRYTHmN6JY7A4lyT5uVQ,14907
+fabricatio/capabilities/task.py,sha256=s6FiC9Wg_l-qSa2LgsoKV9f6wXZN6Q_FlWn3XbSnrys,4618
+fabricatio/config.py,sha256=yPJjrGhvoWyXfLBTJp2pMvHt9F-0uskE-va7QDo0rxI,13525
+fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
+fabricatio/decorators.py,sha256=uzsP4tFKQNjDHBkofsjjoJA0IUAaYOtt6YVedoyOqlo,6551
+fabricatio/fs/curd.py,sha256=faMstgGUiQ4k2AW3OXfvvWWTldTtKXco7QINYaMjmyA,3981
+fabricatio/fs/readers.py,sha256=Pz1-cdZYtmqr032dsroImlkFXAd0kCYY_9qVpD4UrG4,1045
+fabricatio/fs/__init__.py,sha256=lWcKYg0v3mv2LnnSegOQaTtlVDODU0vtw_s6iKU5IqQ,122
+fabricatio/journal.py,sha256=siqimKF0M_QaaOCMxtjr_BJVNyUIAQWILzE9Q4T6-7c,781
+fabricatio/models/action.py,sha256=VhSXPmHjICaypz6qB-RE7dzvdrL9lbvhY4og32Q-DPI,5939
+fabricatio/models/events.py,sha256=pt-WkFhhA5SXmp6-3Vb_o_7I5xbKoTCJ22GAK7YYwpA,4101
+fabricatio/models/generic.py,sha256=_9GawiKlNMumLH0DqjSkG-ZJ2oKa-8Vcyi2yw-R6lUk,10659
+fabricatio/models/kwargs_types.py,sha256=Xhy5LcTB1oWBGVGipLf5y_dTb7tBzMO5QAQdEfZeI9I,1786
+fabricatio/models/role.py,sha256=gYvleTeKUGDUNKPAC5B0EPMLC4jZ4vHsFHmHiVXkU6c,1830
+fabricatio/models/task.py,sha256=BRE3XBQXTXH7UHsJDN7UzxIBRQbDVf7T4a00_111inw,10996
+fabricatio/models/tool.py,sha256=WTFnpF6xZ1nJbmIOonLsGQcM-kkDCeZiAFqyil9xg2U,6988
+fabricatio/models/usages.py,sha256=wLKzJ6dzik6RBgyK-sLdmzginPeuBOcsB7RQXO0Nvjo,25804
+fabricatio/models/utils.py,sha256=QI3bYrKBbzLbKvyzVrZXGcWq3trOOTE-hQAC_WNvjMg,4457
+fabricatio/parser.py,sha256=BKYaXieHveo99xFay8YyYBa9Uo1-DwCZ-Fzx-k_CMeI,5051
+fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
+fabricatio/toolboxes/fs.py,sha256=YkNgon5-bvCiPVEND9971W-6wj8btKNL6nGry2otn9I,498
+fabricatio/toolboxes/task.py,sha256=kU4a501awIDV7GwNDuSlK3_Ym-5OhCp5sS-insTmUmQ,269
+fabricatio/toolboxes/__init__.py,sha256=b13KmASO8q5fBLwew964fn9oH86ER5g-S1PgA4fZ_xs,482
+fabricatio/_rust.pyi,sha256=0wCqtwWkVxxoqprvk8T27T8QYKIAKHS7xgsmdMNjQKc,1756
+fabricatio/_rust_instances.py,sha256=dl0-yZ4UvT5g20tQgnPJpmqtkjFGXNG_YK4eLfi_ugQ,279
+fabricatio/__init__.py,sha256=cj0E_rYiyGckvMy-hiXSKxNWwF-drkj4NGOXq5eZHuw,1330
+fabricatio/_rust.cp312-win_amd64.pyd,sha256=6jqod91J-z0dk_plffA1H5DPttEA1Ksfy5ZFM-87GQE,1256448
+fabricatio-0.2.4.dev0.data/scripts/tdown.exe,sha256=7sUpScFur_OgeyVJKmyP4HHzRk2pnPHVAtG8VAUNlNE,3395584
+fabricatio-0.2.4.dev0.dist-info/RECORD,,

fabricatio/actions/communication.py

@@ -1,15 +0,0 @@
-"""Actions that involve communication with the user."""
-
-from fabricatio.models.action import Action
-from fabricatio.models.task import Task
-
-
-class Examining(Action):
-    """Action that examines the input data."""
-
-    name: str = "talk"
-    output_key: str = "examine_pass"
-
-    async def _execute(self, exam_target: Task[str], to_examine: str, **_) -> bool:
-        """Examine the input data."""
-        # TODO

fabricatio/actions/transmission.py

@@ -1,23 +0,0 @@
-"""Actions for transmitting tasks to targets."""
-
-from typing import List
-
-from fabricatio.journal import logger
-from fabricatio.models.action import Action
-from fabricatio.models.events import EventLike
-from fabricatio.models.task import Task
-
-
-class PublishTask(Action):
-    """An action that publishes a task to a list of targets."""
-
-    name: str = "publish_task"
-    """The name of the action."""
-    description: str = "Publish a task to a list of targets."
-    """The description of the action."""
-
-    async def _execute(self, send_targets: List[EventLike], send_task: Task, **_) -> None:
-        """Execute the action by sending the task to the specified targets."""
-        logger.info(f"Sending task {send_task.name} to {send_targets}")
-        for target in send_targets:
-            await send_task.move_to(target).publish()

fabricatio-0.2.3.dev2.dist-info/RECORD

@@ -1,37 +0,0 @@
-fabricatio-0.2.3.dev2.dist-info/METADATA,sha256=BlVLqYv59JMHHleZ0q386UhyragcQ3iZbMXonozLX3c,12339
-fabricatio-0.2.3.dev2.dist-info/WHEEL,sha256=tpW5AN9B-9qsM9WW2FXG2r193YXiqexDadpKp0A2daI,96
-fabricatio-0.2.3.dev2.dist-info/licenses/LICENSE,sha256=do7J7EiCGbq0QPbMAL_FqLYufXpHnCnXBOuqVPwSV8Y,1088
-fabricatio/actions/communication.py,sha256=NZxIIncKgJSDyBrqNebUtH_haqtxHa8ld2TZxT3CMdU,429
-fabricatio/actions/transmission.py,sha256=xpvKqbXqgpi1BWy-vUUvmd8NZ1GhRNfsYUBp-l2jLyk,862
-fabricatio/actions/__init__.py,sha256=eFmFVPQvtNgFynIXBVr3eP-vWQDWCPng60YY5LXvZgg,115
-fabricatio/capabilities/rag.py,sha256=WeUn-7wppyISbmNpm4flogzUZrCnrJ5iQYNjepZpdww,6954
-fabricatio/capabilities/rating.py,sha256=zmTUvsUfxFgovRQzy4djL2zKRYTHmN6JY7A4lyT5uVQ,14907
-fabricatio/capabilities/task.py,sha256=d2xtrwQxXWI40UskQCR5YhHarY7ST0ppr8TjY12uWQE,5327
-fabricatio/config.py,sha256=6_cpyGu87NmuPC2Kc0fq_cwOogH3fjXTILiDY7poWi4,12041
-fabricatio/core.py,sha256=VQ_JKgUGIy2gZ8xsTBZCdr_IP7wC5aPg0_bsOmjQ588,6458
-fabricatio/decorators.py,sha256=uzsP4tFKQNjDHBkofsjjoJA0IUAaYOtt6YVedoyOqlo,6551
-fabricatio/fs/curd.py,sha256=faMstgGUiQ4k2AW3OXfvvWWTldTtKXco7QINYaMjmyA,3981
-fabricatio/fs/readers.py,sha256=Pz1-cdZYtmqr032dsroImlkFXAd0kCYY_9qVpD4UrG4,1045
-fabricatio/fs/__init__.py,sha256=lWcKYg0v3mv2LnnSegOQaTtlVDODU0vtw_s6iKU5IqQ,122
-fabricatio/journal.py,sha256=siqimKF0M_QaaOCMxtjr_BJVNyUIAQWILzE9Q4T6-7c,781
-fabricatio/models/action.py,sha256=NpklAVUHYO5JIY9YLwYowZ-U8R9CFf5aC10DhLF7gxQ,5924
-fabricatio/models/events.py,sha256=mrihNEFgQ5o7qFWja1z_qX8dnaTLwPBoJdVlzxQV5oM,2719
-fabricatio/models/generic.py,sha256=WEjZ96rTyBjaBjkM6e8E4Pg_Naot4xWRvGJteqBiCCI,5133
-fabricatio/models/kwargs_types.py,sha256=a-e7rdMZJi8xTBL_RLmTC9OPzI-Js7rlS689PR03VvA,1401
-fabricatio/models/role.py,sha256=gYvleTeKUGDUNKPAC5B0EPMLC4jZ4vHsFHmHiVXkU6c,1830
-fabricatio/models/task.py,sha256=ip6VeOV7vgXqhiQFOCjVl3hzc6lgdhfyvxbBuSz2-C0,11529
-fabricatio/models/tool.py,sha256=WTFnpF6xZ1nJbmIOonLsGQcM-kkDCeZiAFqyil9xg2U,6988
-fabricatio/models/usages.py,sha256=bzsTDrAekiQyIwKeWds5YdgsXk8qiZkD7OZdno1Q_Ck,28213
-fabricatio/models/utils.py,sha256=mXea76bd4r2jy_zx74GM4t5kCvkMu0JTOaw_VGvTCxk,3952
-fabricatio/parser.py,sha256=uLabsvF07wRKW1PoTGuGEENCx3P4mhmuO8JkmOEkKko,3522
-fabricatio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fabricatio/toolboxes/arithmetic.py,sha256=WLqhY-Pikv11Y_0SGajwZx3WhsLNpHKf9drzAqOf_nY,1369
-fabricatio/toolboxes/fs.py,sha256=YkNgon5-bvCiPVEND9971W-6wj8btKNL6nGry2otn9I,498
-fabricatio/toolboxes/task.py,sha256=kU4a501awIDV7GwNDuSlK3_Ym-5OhCp5sS-insTmUmQ,269
-fabricatio/toolboxes/__init__.py,sha256=b13KmASO8q5fBLwew964fn9oH86ER5g-S1PgA4fZ_xs,482
-fabricatio/_rust.pyi,sha256=0wCqtwWkVxxoqprvk8T27T8QYKIAKHS7xgsmdMNjQKc,1756
-fabricatio/_rust_instances.py,sha256=dl0-yZ4UvT5g20tQgnPJpmqtkjFGXNG_YK4eLfi_ugQ,279
-fabricatio/__init__.py,sha256=opIrN8lGyT-h2If4Qez0bRuWBa3uIT9GsM9CZy7_XJ0,1100
-fabricatio/_rust.cp312-win_amd64.pyd,sha256=wJkACEnysxtUfMBOwQ3851hSYNy1HOtY9vSIepLzEFg,1272320
-fabricatio-0.2.3.dev2.data/scripts/tdown.exe,sha256=A9eIQbGxwDhpQ0gYqtEHA4Ms-LakyYkSkjiNnccvfYY,3398144
-fabricatio-0.2.3.dev2.dist-info/RECORD,,