fabricatio 0.1.0__tar.gz → 0.1.1__tar.gz

{fabricatio-0.1.0 → fabricatio-0.1.1}/.github/workflows/build-package.yaml

@@ -1,58 +1,68 @@
-name: Build and Release
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  check-and-release:
-    runs-on: windows-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v5
-        with:
-          version: "latest"
-
-      - name: Build
-        run: |
-          uv build
-
-      - name: Get current version
-        id: get_version
-        run: |
-          CURRENT_VERSION=$(grep '^version' pyproject.toml | cut -d '"' -f 2)
-          echo "CURRENT_VERSION=v$CURRENT_VERSION" >> $GITHUB_OUTPUT
-        shell: bash
-      - name: Get latest tag
-        uses: JinoArch/get-latest-tag@latest
-        id: tag
-
-      - name: Check if version has changed
-        id: check_version_change
-        run: |
-          LATEST_TAG=${{ steps.tag.outputs.latestTag  }}
-          echo "Latest tag is $LATEST_TAG"
-          echo "Current version is ${{ steps.get_version.outputs.CURRENT_VERSION }}"
-          if [ "$LATEST_TAG" != "${{ steps.get_version.outputs.CURRENT_VERSION }}" ]; then
-              echo "VERSION_CHANGED=true" >> $GITHUB_OUTPUT
-            else
-              echo "VERSION_CHANGED=false" >> $GITHUB_OUTPUT
-          fi
-        shell: bash
-
-
-      - name: Create Release and upload assets
-        if: ${{ steps.check_version_change.outputs.VERSION_CHANGED == 'true' }}
-        id: create_release
-        uses: softprops/action-gh-release@v2
-        with:
-          tag_name: ${{ steps.get_version.outputs.CURRENT_VERSION }}
-          name: ${{ steps.get_version.outputs.CURRENT_VERSION }}
-          files: |
-            dist/*
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
+name: Build and Release
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  check-and-release:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Build
+        run: |
+          uv build
+
+      - name: Get current version
+        id: get_version
+        run: |
+          CURRENT_VERSION=$(grep '^version' pyproject.toml | cut -d '"' -f 2)
+          echo "CURRENT_VERSION=v$CURRENT_VERSION" >> $GITHUB_OUTPUT
+        shell: bash
+      - name: Get latest tag
+        uses: JinoArch/get-latest-tag@latest
+        id: tag
+
+      - name: Check if version has changed
+        id: check_version_change
+        run: |
+          LATEST_TAG=${{ steps.tag.outputs.latestTag  }}
+          echo "Latest tag is $LATEST_TAG"
+          echo "Current version is ${{ steps.get_version.outputs.CURRENT_VERSION }}"
+          if [ "$LATEST_TAG" != "${{ steps.get_version.outputs.CURRENT_VERSION }}" ]; then
+              echo "VERSION_CHANGED=true" >> $GITHUB_OUTPUT
+            else
+              echo "VERSION_CHANGED=false" >> $GITHUB_OUTPUT
+          fi
+        shell: bash
+
+
+      - name: Create Release and upload assets
+        if: ${{ steps.check_version_change.outputs.VERSION_CHANGED == 'true' }}
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.get_version.outputs.CURRENT_VERSION }}
+          name: ${{ steps.get_version.outputs.CURRENT_VERSION }}
+          files: |
+            dist/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT }}
+
+      - name: Upload to PyPI
+        if: ${{ steps.check_version_change.outputs.VERSION_CHANGED == 'true' }}
+        run: |
+          uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}

fabricatio-0.1.1/.github/workflows/ruff.yaml

@@ -0,0 +1,20 @@
+name: Pre-commit checks
+
+on:
+  pull_request:
+    branches:
+      - '**'
+  push:
+    branches:
+      - '**'
+
+jobs:
+  ruff-linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup ruff
+        uses: astral-sh/ruff-action@v3
+        with:
+          github-token: ${{ secrets.PAT }}

{fabricatio-0.1.0 → fabricatio-0.1.1}/.gitignore

@@ -1,11 +1,11 @@
-# Python-generated files
-__pycache__/
-*.py[oc]
-build/
-dist/
-wheels/
-*.egg-info
-
-# Virtual environments
-.venv
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
 .idea

{fabricatio-0.1.0 → fabricatio-0.1.1}/.python-version

@@ -1 +1 @@
-3.12
+3.12

{fabricatio-0.1.0 → fabricatio-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fabricatio
-Version: 0.1.0
+Version: 0.1.1
 Summary: A LLM multi-agent framework.
 Author-email: Whth <zettainspector@foxmail.com>
 License: MIT License
@@ -25,6 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
+Keywords: agents,ai,llm,multi-agent
 Classifier: Framework :: AsyncIO
 Classifier: Framework :: Pydantic :: 2
 Classifier: License :: OSI Approved :: MIT License
@@ -36,11 +37,90 @@ Requires-Dist: aiohttp>=3.11.11
 Requires-Dist: aiomultiprocess>=0.9.1
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: asyncio>=3.4.3
+Requires-Dist: gitpython>=3.1.44
 Requires-Dist: litellm>=1.60.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: pydantic-settings>=2.7.1
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: pymitter>=1.0.0
+Requires-Dist: regex>=2024.11.6
 Requires-Dist: rich>=13.9.4
-Provides-Extra: cli
-Requires-Dist: typer>=0.15.1; extra == 'cli'
+Requires-Dist: shutilwhich>=1.1.0
+Description-Content-Type: text/markdown
+
+## Usage
+
+### Defining a Task
+
+```python
+from fabricatio.models.task import Task
+
+task = Task(name="say hello", goal="say hello", description="say hello to the world")
+```
+
+
+### Creating an Action
+
+```python
+from fabricatio import Action, logger
+from fabricatio.models.task import Task
+
+class Talk(Action):
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+```
+
+
+### Assigning a Role
+
+```python
+from fabricatio.models.role import Role
+from fabricatio.models.action import WorkFlow
+
+class TestWorkflow(WorkFlow):
+    pass
+
+role = Role(name="Test Role", actions=[TestWorkflow()])
+```
+
+
+### Logging
+
+Fabricatio uses Loguru for logging. You can configure the log level and file in the `config.py` file.
+
+```python
+from fabricatio.config import DebugConfig
+
+debug_config = DebugConfig(log_level="DEBUG", log_file="fabricatio.log")
+```
+
+
+## Configuration
+
+Fabricatio uses Pydantic for configuration management. You can define your settings in the `config.py` file.
+
+```python
+from fabricatio.config import Settings
+
+settings = Settings(llm=LLMConfig(api_endpoint="https://api.example.com"))
+```
+
+
+## Testing
+
+Fabricatio includes a set of tests to ensure the framework works as expected. You can run the tests using `pytest`.
+
+```bash
+pytest
+```
+
+
+## Contributing
+
+Contributions to Fabricatio are welcome! Please submit a pull request with your changes.
+
+## License
+
+Fabricatio is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

fabricatio-0.1.1/README.md

@@ -0,0 +1,76 @@
+## Usage
+
+### Defining a Task
+
+```python
+from fabricatio.models.task import Task
+
+task = Task(name="say hello", goal="say hello", description="say hello to the world")
+```
+
+
+### Creating an Action
+
+```python
+from fabricatio import Action, logger
+from fabricatio.models.task import Task
+
+class Talk(Action):
+    async def _execute(self, task_input: Task[str], **_) -> Any:
+        ret = "Hello fabricatio!"
+        logger.info("executing talk action")
+        return ret
+```
+
+
+### Assigning a Role
+
+```python
+from fabricatio.models.role import Role
+from fabricatio.models.action import WorkFlow
+
+class TestWorkflow(WorkFlow):
+    pass
+
+role = Role(name="Test Role", actions=[TestWorkflow()])
+```
+
+
+### Logging
+
+Fabricatio uses Loguru for logging. You can configure the log level and file in the `config.py` file.
+
+```python
+from fabricatio.config import DebugConfig
+
+debug_config = DebugConfig(log_level="DEBUG", log_file="fabricatio.log")
+```
+
+
+## Configuration
+
+Fabricatio uses Pydantic for configuration management. You can define your settings in the `config.py` file.
+
+```python
+from fabricatio.config import Settings
+
+settings = Settings(llm=LLMConfig(api_endpoint="https://api.example.com"))
+```
+
+
+## Testing
+
+Fabricatio includes a set of tests to ensure the framework works as expected. You can run the tests using `pytest`.
+
+```bash
+pytest
+```
+
+
+## Contributing
+
+Contributions to Fabricatio are welcome! Please submit a pull request with your changes.
+
+## License
+
+Fabricatio is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

fabricatio-0.1.1/examples/minor/hello_fabricatio.py

@@ -0,0 +1,29 @@
+import asyncio
+from typing import Any
+
+from fabricatio import Action, Role, Task, WorkFlow, logger
+
+task = Task(name="say hello", goal="say hello", description="say hello to the world")
+
+
+class Talk(Action):
+    """Action that says hello to the world."""
+
+    name: str = "talk"
+    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:
+    """Main function."""
+    Role(name="talker", description="talker role", registry={task.pending_label: WorkFlow(name="talk", steps=(Talk,))})
+
+    logger.success(f"Result: {await task.delegate()}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

fabricatio-0.1.1/pyproject.toml

@@ -0,0 +1,137 @@
+[project]
+name = "fabricatio"
+version = "0.1.1"
+description = "A LLM multi-agent framework."
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Whth", email = "zettainspector@foxmail.com" }
+]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Framework :: AsyncIO",
+    "Framework :: Pydantic :: 2",
+    "Typing :: Typed",
+]
+keywords = [
+    "ai",
+    "agents",
+    "multi-agent",
+    "llm",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "aiohttp>=3.11.11",
+    "aiomultiprocess>=0.9.1",
+    "appdirs>=1.4.4",
+    "asyncio>=3.4.3",
+    "gitpython>=3.1.44",
+    "litellm>=1.60.0",
+    "loguru>=0.7.3",
+    "pydantic>=2.10.6",
+    "pydantic-settings>=2.7.1",
+    "pymitter>=1.0.0",
+    "regex>=2024.11.6",
+    "rich>=13.9.4",
+    "shutilwhich>=1.1.0",
+]
+
+
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.4",
+    "pytest-asyncio>=0.25.3",
+    "pytest-cov>=6.0.0",
+    "pytest-env>=1.1.5",
+    "pytest-flake8>=1.3.0",
+    "pytest-mock>=3.14.0",
+    "pytest-rerunfailures>=15.0",
+    "pytest-xdist>=3.6.1",
+    "ruff>=0.9.4",
+    "uv>=0.5.29",
+]
+cli = [
+    "typer>=0.15.1",
+]
+rag = [
+    "faiss-cpu>=1.10.0",
+    "pymilvus>=2.5.4",
+]
+
+
+[tool.ruff]
+include = ["pyproject.toml", "src/fabricatio/*.py", "examples/*.py"]
+line-length = 120
+target-version = "py312"
+[tool.ruff.format]
+quote-style = "double" # Like Black, use double quotes for strings.
+
+[tool.ruff.lint]
+select = [
+    "F",        # Pyflakes
+    "I",        # isort
+    "N",        # pep8-naming
+    "D",        # pydocstyle
+    "W",        # warnings
+    "ANN",      # flake8-annotations
+    "ASYNC",    # flake8-async
+    "S",        # flake8-bandit
+    "BLE",      # flake8-blind-except
+    "C90",      # flake8-complexity
+    "B",        # flake8-bugbear
+    "C4",       # flake8-comprehensions
+    "T10",      # flake8-debugger
+    "T20",      # flake8-print
+    "PYI",      # flake8-pyi
+    "PT",       # flake8-pytest-style
+    "RET",      # flake8-return
+    "SIM",      # flake8-simplify
+    "TC",       # flake8-type-checking
+    "PTH",      # flake8-use-pathlib
+    "PLC",      # convention
+    "PLE",      # error
+    "PLR",      # refactoring
+    "PLW",      # warning
+    "RUF",      # Ruff-specific rules
+]
+ignore=[
+    "S101",
+    "ANN401",
+    "ANN003",
+    "D100",
+    "PYI063",
+    "ASYNC109"
+]
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+ignore-decorators = ["typing.overload"]
+[tool.ruff.lint.pylint]
+max-args = 15
+
+[tool.pytest.ini_options]
+addopts = "-ra -q"
+testpaths = [
+    "tests",
+]
+
+
+[[tool.uv.index]]
+url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"
+
+[[tool.uv.index]]
+url = "https://mirrors.huaweicloud.com/repository/pypi/simple"
+
+[[tool.uv.index]]
+url = "https://mirrors.aliyun.com/pypi/simple/"
+
+[[tool.uv.index]]
+url = "https://mirrors.bfsu.edu.cn/pypi/web/simple"
+default = true

{fabricatio-0.1.0 → fabricatio-0.1.1}/src/fabricatio/__init__.py

@@ -1,18 +1,24 @@
-from fabricatio.core import Env
-from fabricatio.logger import logger
-from fabricatio.models.action import Action, WorkFlow
-from fabricatio.models.events import Event
-from fabricatio.models.role import Role
-from fabricatio.models.tool import ToolBox
-from fabricatio.models.utils import Messages
-
-__all__ = [
-    "Env",
-    "logger",
-    "Action",
-    "Event",
-    "Messages",
-    "Role",
-    "ToolBox",
-    "WorkFlow",
-]
+"""Fabricatio is a Python library for building llm app using event-based agent structure."""
+
+from fabricatio.core import env
+from fabricatio.journal import logger
+from fabricatio.models.action import Action, WorkFlow
+from fabricatio.models.events import Event
+from fabricatio.models.role import Role
+from fabricatio.models.task import Task
+from fabricatio.models.tool import ToolBox
+from fabricatio.models.utils import Messages
+from fabricatio.parser import Capture
+
+__all__ = [
+    "Action",
+    "Capture",
+    "Event",
+    "Messages",
+    "Role",
+    "Task",
+    "ToolBox",
+    "WorkFlow",
+    "env",
+    "logger",
+]