matrix-for-agents 0.1.0__tar.gz

matrix_for_agents-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Agent-Matrix Contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

matrix_for_agents-0.1.0/MANIFEST.in

@@ -0,0 +1,68 @@
+# Include essential files
+include README.md
+include LICENSE
+include requirements.txt
+include pyproject.toml
+
+# Include example scripts
+include src/agentmatrix/cli_runner.py
+
+# Include Python source files from src
+recursive-include src/agentmatrix/agents *.py
+recursive-include src/agentmatrix/core *.py
+recursive-include src/agentmatrix/skills *.py
+recursive-include src/agentmatrix/backends *.py
+recursive-include src/agentmatrix/db *.py
+
+# Include configuration and documentation files
+recursive-include src/agentmatrix/profiles *.yaml *.yml
+exclude src/agentmatrix/profiles/.env
+recursive-include src/agentmatrix/docs *.md *.txt
+
+# Exclude test files and directories
+exclude test/*
+exclude Tests/*
+recursive-exclude test *
+recursive-exclude Tests *
+
+# Exclude sample and workspace directories
+exclude Samples/*
+exclude TestWorkspace/*
+
+# Exclude database files
+exclude *.db
+exclude agents.db
+
+# Exclude environment and configuration files
+exclude .env
+exclude .env.local
+exclude .env.*.local
+
+# Exclude log and download directories
+exclude logs/*
+exclude downloads/*
+
+# Exclude Python cache
+exclude __pycache__
+recursive-exclude __pycache__ *
+exclude *.pyc
+exclude *.pyo
+exclude *.pyd
+
+# Exclude development tools and IDE files
+exclude .vscode/*
+exclude .idea/*
+exclude *.swp
+exclude *.swo
+
+# Exclude version control
+exclude .git/*
+exclude .gitignore
+
+# Exclude project entry scripts (keep cli_runner.py as example)
+exclude main.py
+exclude server.py
+
+# Exclude OS files
+exclude .DS_Store
+exclude Thumbs.db

matrix_for_agents-0.1.0/PKG-INFO

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: matrix-for-agents
+Version: 0.1.0
+Summary: An intelligent agent framework with pluggable skills and LLM integrations
+Author: Agent-Matrix Contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/webdkt/agentmatrix
+Project-URL: Documentation, https://github.com/webdkt/agentmatrix/docs
+Project-URL: Repository, https://github.com/webdkt/agentmatrix
+Project-URL: Issues, https://github.com/webdkt/agentmatrix/issues
+Keywords: agents,ai,llm,framework,multi-agent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: uvicorn>=0.23.0
+Requires-Dist: websockets>=11.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: aioconsole>=0.6.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: Jinja2>=3.1.0
+Requires-Dist: chromadb>=0.4.0
+Requires-Dist: sentence-transformers>=2.2.0
+Requires-Dist: trafilatura>=1.6.0
+Requires-Dist: DrissionPage>=4.0.0
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: marker-pdf==1.8.0
+Requires-Dist: PyMuPDF>=1.23.0
+Requires-Dist: libtmux>=0.52.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: flake8>=6.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# Agent-Matrix
+
+A cognition-centric autonomous agent framework with pluggable skills and multi-backend LLM integrations.
+
+## Overview
+
+Agent-Matrix is a multi-agent framework where agents act as independent "digital employees" that collaborate through asynchronous messaging (similar to email) rather than rigid API calls.
+
+Designed for building robust, intelligent systems that can reason, negotiate, and handle ambiguity like humans do.
+
+## Core Philosophy
+
+The core philosophy is simple: Many agent frameworks force powerful LLMs to "think" in rigid formats like JSON, which is error-prone and limits their reasoning capabilities.
+
+**Agent-Matrix's approach**: Let LLMs communicate, think, and output in natural language. The brain should focus on reasoning, not JSON conversion.
+
+Agent-Matrix solves this with a **Brain + Cerebellum + Body** architecture:
+
+- 🧠 **Brain (The LLM):** Strategic thinker. Uses natural language for high-level reasoning and intent formation. Like a pilot in a cockpit deciding "where to go" without worrying about switch details.
+- 🧠 **Cerebellum (The SLM):** Precise interface manager. Translates natural language intent into machine-executable commands (JSON). Understands intent and fills in JSON.
+- 💪 **Body**: The Python program that executes functions based on JSON and provides feedback.
+
+When the brain's intent is unclear (e.g., "send email" without specifying recipient), the cerebellum doesn't error or blindly execute. Instead, it **initiates "negotiation"** by sending an internal query back to the brain for clarification. This internal dialogue makes agents exceptionally robust and intelligent.
+
+## Core Concepts
+
+- **Agent**: A digital employee with a specific persona and capability list
+- **PostOffice**: Central communication hub for all inter-agent messages
+- **Runtime (the Matrix)**: Execution environment including memory structures and directory layout
+- **Signal**: Information unit in the system - new emails, tool results, or cerebellum queries
+- **Email**: How agents communicate. Email reply chains automatically maintain conversation context
+
+## How It Works: Turn-Based Loop
+
+An agent's lifecycle is like a turn-based game:
+
+1. **Awake**: A `Signal` arrives, waking the agent from sleep
+2. **Reasoning**: Brain analyzes signal and history, reasoning in the `THOUGHT` section (internal monologue)
+3. **Decision**: Brain makes a decision and outputs a clear `ACTION SIGNAL`, e.g., "Send Coder an email with code review request"
+4. **Negotiation**: Cerebellum intercepts the instruction
+   - **If clear**: Translate to JSON and let it through
+   - **If unclear**: Pause execution, generate an `[INTERNAL QUERY]` signal back to brain, starting a "sub-turn" for clarification
+5. **Execution**: Agent's "body" executes the cerebellum-validated instruction
+6. **Feedback & Rest**: Action results immediately return as `[BODY FEEDBACK]` signal, triggering next turn. This continues until brain explicitly decides `rest_n_wait` action
+
+See `docs/Design.md` for detailed architecture.
+
+## Key Features & Advantages
+
+- ✅ **Exceptional Robustness**: "Negotiation mechanism" fundamentally eliminates execution failures from format errors or unclear intent
+- 🧠 **Stronger Intelligence**: Decouples "thinking" from "actioning", letting the brain (LLM) do complex reasoning unencumbered by formats
+- 🌐 **True Asynchronous Collaboration**: Message passing through "post office" naturally supports complex, parallel social agent workflows
+- 🧘 **Explicit Will-Driven**: Agents have "free will". Must actively decide when to rest (`rest_n_wait`), making multi-step tasks simple and natural
+
+**The biggest advantage**: Makes workflow design remarkably simple
+
+## Trade-offs
+
+Everything has trade-offs. This architecture has two potential drawbacks:
+
+1. When brain and cerebellum negotiate clarification, multiple rounds of dialogue may consume more tokens
+2. Fully asynchronous mechanism with email communication means each agent processes emails serially. While beneficial, tasks may sit in queue longer before processing
+
+However, these aren't major issues. What matters most for agents is intelligence and robustness - autonomously completing work correctly. Taking one hour vs two hours doesn't matter much. And token costs will only decrease long-term. Spending tokens to do things right is worth it.
+
+## Installation
+
+```bash
+pip install agent-matrix
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from agent_matrix import AgentMatrix
+
+# Initialize the framework
+matrix = AgentMatrix(
+    agent_profile_path="profiles",
+    matrix_path="./my_workspace"
+)
+
+# Start the runtime (this will load all agents from profiles)
+await matrix.run()
+```
+
+### Using the CLI Runner (Recommended for First-Time Users)
+
+The package includes `cli_runner.py` as a practical example for interacting with agents:
+
+```python
+# Run the CLI runner
+python cli_runner.py
+```
+
+The CLI runner provides:
+- 📥 Interactive command-line interface
+- 💬 Real-time agent communication
+- 🔄 Multi-session support
+- 📝 Message reply tracking
+
+**Usage Example:**
+```bash
+# Start the CLI
+$ python cli_runner.py
+>>> 系统启动。可以在下面输入指令。
+>>> 例如: Planner: 帮我分析数据
+
+# Send a message to an agent
+>> Planner: 请帮我爬取网页数据
+
+# Start a new session
+>> new session
+✅ 新会话开始 ID: a1b2c3d4-...
+
+# Reply to a specific message
+>> reply: msg-123: 谢谢你的分析
+
+# Exit and save
+>> exit
+```
+
+The CLI runner demonstrates:
+- How to initialize the AgentMatrix framework
+- How to set up event callbacks
+- How to communicate with agents through the User proxy
+- How to handle multi-session conversations
+
+For full source code, see `cli_runner.py` in the package installation directory.
+
+## Project Structure
+
+```
+agent-matrix/
+├── agents/          # Agent implementations
+│   ├── base.py      # Base agent class
+│   └── post_office.py  # Message routing system
+├── core/            # Core framework
+│   ├── runtime.py   # Main runtime
+│   ├── message.py   # Email/Signal definitions
+│   └── browser/     # Browser automation
+├── skills/          # Built-in skills
+│   ├── data_crawler.py    # Web scraping
+│   ├── web_searcher.py    # Web search
+│   └── filesystem.py      # File operations
+├── backends/        # LLM integrations
+├── db/              # Database layer
+├── profiles/        # Agent configurations (YAML)
+└── docs/            # Documentation
+```
+
+## Usage Examples
+
+### Agent Communication
+
+```python
+from agent_matrix import Email
+
+email = Email(
+    sender="researcher",
+    recipient="analyst",
+    subject="Data Analysis Request",
+    body="Please analyze the crawled data...",
+    user_session_id="session_123"
+)
+
+# Send through post office
+await matrix.post_office.dispatch(email)
+```
+
+### Built-in Skills
+
+Agents automatically load skills based on their profiles:
+
+```yaml
+# profiles/analyst.yaml
+name: "analyst"
+description: "Data analysis specialist"
+skills:
+  - filesystem
+  - web_searcher
+```
+
+## Requirements
+
+- Python 3.8 or higher
+- See `requirements.txt` for full dependency list
+
+## License
+
+Apache License 2.0 - see [LICENSE](LICENSE) file for details
+
+## Contributing
+
+Contributions welcome! Please feel free to submit a Pull Request.
+
+## Roadmap
+
+- [ ] Enhanced multi-agent collaboration patterns
+- [ ] More built-in skills
+- [ ] Improved documentation and tutorials
+- [ ] Performance optimizations
+- [ ] Additional backend integrations
+
+## Acknowledgments
+
+- Built with [FastAPI](https://fastapi.tiangolo.com/)
+- Browser automation powered by [DrissionPage](https://drissionpage.cn/)
+- Vector search with [ChromaDB](https://www.trychroma.com/)
+
+---
+
+**Note**: Agent-Matrix is currently in alpha release (v0.1.0). APIs and features may evolve as we develop the framework.
+
+For Chinese documentation, see [readme_zh.md](readme_zh.md)