delfhos 0.4.0__tar.gz

delfhos-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

delfhos-0.4.0/PKG-INFO

@@ -0,0 +1,454 @@
+Metadata-Version: 2.4
+Name: delfhos
+Version: 0.4.0
+Summary: Delfhos — AI agent SDK with typed connections and tool orchestration
+Author-email: David Serrano <davidsd.2704@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/DavidFraifer/delfhos
+Project-URL: Source, https://github.com/DavidFraifer/delfhos
+Project-URL: Issues, https://github.com/DavidFraifer/delfhos/issues
+Keywords: ai,agents,sdk,automation,mcp,gemini
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-genai>=1.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: tenacity>=8.0.0
+Requires-Dist: google-auth>=2.0.0
+Requires-Dist: google-auth-oauthlib>=1.0.0
+Requires-Dist: google-auth-httplib2>=0.1.0
+Requires-Dist: google-api-python-client>=2.0.0
+Provides-Extra: sql
+Requires-Dist: psycopg2-binary<3.0,>=2.9; extra == "sql"
+Requires-Dist: mysql-connector-python<9.0,>=8.0; extra == "sql"
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Dynamic: license-file
+
+# Delfhos
+
+**Delfhos** is an open-source AI agent SDK. Give it connections to your tools and describe what you want in plain English — Delfhos takes care of the rest.
+
+```python
+from delfhos import Agent
+from delfhos.tools import Gmail, SQL
+
+gmail = Gmail(oauth_credentials="client_secrets.json")
+db    = SQL(url="postgresql://user:pass@host/mydb")
+
+with Agent(tools=[gmail, db]) as agent:
+    agent.run("How many users signed up this week? Email a summary to the team.")
+```
+
+---
+
+## Install
+
+```bash
+pip install delfhos
+```
+
+Or from source:
+
+```bash
+git clone https://github.com/DavidFraifer/delfhos
+cd delfhos
+pip install -e .
+```
+
+**Requirements:** Python ≥ 3.9, a Gemini API key.
+
+```bash
+export GEMINI_API_KEY="your-key-here"
+```
+
+---
+
+## Quickstart
+
+```bash
+python -m examples.PersistentMemory.memory_demo
+```
+
+```python
+from delfhos import Agent
+from delfhos.tools import WebSearch
+
+with Agent(
+    tools=[WebSearch()],
+    system_prompt="You are a helpful research assistant.",
+) as agent:
+    agent.run("What are the top 3 AI trends in 2026? Give a brief summary.")
+```
+
+---
+
+## Error Handling
+
+Delfhos uses a unified error system in [delfhos/errors.py](delfhos/errors.py).
+
+All SDK errors include:
+1. A stable error code (for logs and support)
+2. A clear message with context
+3. A fix-oriented hint
+
+Example output shape:
+
+```text
+❌ [ERR_TOOL_001] Delfhos Error
+----------------------------------------
+Message: Tool 'web_search' failed during execution: network timeout
+----------------------------------------
+💡 Hint: Review the arguments sent to the tool...
+```
+
+Common error families:
+
+| Code | Exception | Typical Cause |
+|---|---|---|
+| `ERR_TOOL_001` | `ToolExecutionError` | Tool runtime failure |
+| `ERR_TOOL_002` | `ToolDefinitionError` | Invalid custom tool definition |
+| `ERR_CONN_001` | `ConnectionConfigurationError` | Missing/invalid connection config |
+| `ERR_CONN_002` | `ConnectionFileNotFoundError` | Credentials file path not found |
+| `ERR_ENV_001` | `EnvironmentKeyError` | Missing environment variable |
+| `ERR_REQ_001` | `OptionalDependencyError` | Missing optional package |
+| `ERR_MCP_001` | `MCPConnectionError` | MCP server start/connect issues |
+
+Catch by base class when you want one handler for all SDK-level failures:
+
+```python
+from delfhos.errors import DelfhosConfigError
+
+try:
+    agent.run("Send a summary email to the team")
+except DelfhosConfigError as exc:
+    print(str(exc))  # Includes code + message + hint
+```
+
+Notes:
+1. Some errors keep compatibility with Python built-ins for existing code:
+   - `ToolDefinitionError` is also a `TypeError`
+   - `ConnectionConfigurationError` is also a `ValueError`
+   - `ConnectionFileNotFoundError` is also a `FileNotFoundError`
+
+---
+
+## Authentication
+
+All Google connections (Gmail, Sheets, Drive, Calendar, Docs) support three auth methods.
+
+### Service Account (recommended for servers)
+
+Download a service account JSON key from [Google Cloud Console](https://console.cloud.google.com/iam-admin/serviceaccounts), then:
+
+```python
+from delfhos.connections import GmailConnection
+
+gmail = GmailConnection(
+    service_account="path/to/service-account.json",
+    delegated_user="admin@company.com",   # impersonate a Workspace user
+    actions=["read"],                      # optional: restrict capabilities
+)
+```
+
+> **Note:** Service accounts require Google Workspace and domain-wide delegation enabled by a Workspace admin.
+
+### OAuth Client Secrets (for personal accounts)
+
+Download a `client_secrets.json` from [Cloud Console → Credentials](https://console.cloud.google.com/apis/credentials):
+
+```python
+gmail = GmailConnection(
+    oauth_credentials="path/to/client_secrets.json",
+    actions=["read", "send"],
+)
+# First run: opens browser for consent → token cached to ~/.cortex/tokens/
+# Subsequent runs: token loaded automatically and refreshed if expired.
+```
+
+### Action restrictions & scope mapping
+
+The `actions` parameter controls **what the agent can do** and **what OAuth scopes are requested** — minimal privilege by default:
+
+| Connection | Action | Scope requested |
+|---|---|---|
+| Gmail | `read` | `gmail.readonly` |
+| Gmail | `send` | `gmail.send` |
+| Gmail | *(all)* | `gmail.modify` |
+| Sheets | `read` | `spreadsheets.readonly` |
+| Sheets | `write`, `create` | `spreadsheets` |
+| Drive | `search`, `get` | `drive.readonly` |
+| Drive | `create`, `update`, `delete`, `share` | `drive` |
+| Calendar | `list` | `calendar.readonly` |
+| Calendar | `create`, `update`, `delete` | `calendar` |
+| Docs | `read` | `documents.readonly` |
+| Docs | `create`, `update`, `delete` | `documents` + `drive` |
+
+---
+
+## SQL Authentication
+
+`SQLConnection` supports both full connection URLs and individual parameters.
+
+### Connection URL
+```python
+from delfhos.connections import SQLConnection
+db = SQLConnection(url="postgresql://user:pass@host:5432/dbname")
+```
+
+### Individual Parameters
+Recommended if your password contains special characters (like `@`) that would otherwise need URL-encoding.
+
+```python
+db = SQLConnection(
+    host="db.example.co",
+    port=5432,
+    database="postgres",
+    user="postgres",
+    password="your-password",
+    db_type="postgresql" # or "mysql"
+)
+```
+
+---
+
+## Built-in Connections
+
+| Connection | Auth | What it does |
+|---|---|---|
+| `WebSearchConnection` | None | Search the web |
+| `GmailConnection` | SA / OAuth | Read and send emails |
+| `SQLConnection` | URL | Query PostgreSQL / MySQL databases |
+| `SheetsConnection` | SA / OAuth | Read and write Google Sheets |
+| `DriveConnection` | SA / OAuth | Upload, organize, and share files |
+| `CalendarConnection` | SA / OAuth | Create and manage calendar events |
+| `DocsConnection` | SA / OAuth | Create and edit Google Docs |
+
+```python
+# Multiple accounts of the same type
+work  = GmailConnection(service_account="sa.json", delegated_user="work@co.com", name="work")
+inbox = GmailConnection(oauth_credentials="secrets.json", name="personal")
+
+agent = Agent(connections=[work, inbox, db])
+```
+
+---
+
+## Supported Models
+
+Delfhos supports multiple LLM providers:
+
+| Provider | Model | Notes |
+|---|---|---|
+| Google | `gemini-2.5-flash` | Default, fast |
+| Google | `gemini-2.5-flash-lite` | Lighter, cheaper |
+| Google | `gemini-3-flash-preview` | Preview |
+| Google | `gemini-3.1-flash-lite-preview` | Latest lite |
+| Inception | `mercury-2` | Diffusion-based, very fast |
+
+```python
+agent = Agent(
+    connections=[...],
+    light_llm="mercury-2",
+    heavy_llm="mercury-2",
+)
+```
+
+> **Note:** Mercury-2 requires an `INCEPTION_AI` API key in your `.env` file.
+
+---
+
+## Agent Options
+
+```python
+agent = Agent(
+    connections=[...],
+    system_prompt="You are a finance assistant.", # optional role description
+    confirm="write",                          # deployment-time confirm policy
+    on_confirm=my_confirm_callback,             # auto-enables approval callbacks
+    validation_mode=True,                      # dry-run, no real writes
+    light_llm="gemini-3.1-flash-lite-preview", # fast model for filtering
+    heavy_llm="gemini-3.1-flash-lite-preview", # powerful model for code gen
+)
+```
+
+### Run modes
+
+```python
+agent.run_async("Do something")         # async, fire and forget (returns immediately)
+agent.run("Do something", timeout=60)   # blocks until done (synchronous)
+```
+
+### Context manager (Recommended)
+
+```python
+with Agent(tools=[...]) as agent:
+    agent.run("Generate the monthly report.")
+```
+Using the context manager ensures that memory persists correctly when the session exits.
+
+### Default Memory and Chat settings
+If you add `Memory` to your agent, a `Chat(keep=8, summarize=True)` instance is automatically configured:
+
+```python
+from delfhos import Agent, Memory
+
+# Sensible defaults for chat memory are handled automatically
+with Agent(tools=[...], memory=Memory("~/.delfhos/agent_memory.db")) as agent:
+    agent.run("Process overdue invoices")
+```
+
+### Human approval
+
+```python
+with Agent(tools=[...], enable_human_approval=True) as agent:
+    agent.run("Delete all files older than 90 days.")
+
+    pending = agent.get_pending_approvals()
+    agent.approve(pending[0]["request_id"])   # or agent.reject(...)
+```
+
+If you provide `on_confirm=...`, approval is enabled automatically. Use `enable_human_approval=True` when you want manual approve/reject flow without a callback.
+Recommended callback return is `bool` (or `(bool, "reason")` for an explicit message).
+
+`confirm` policy is unified across tool types:
+- Agent deployment policy: `confirm=["send", "delete"]`
+- Tool static nature: pass `kind="send"` in `@tool(...)`
+- Hard override: `@tool(confirm=True)` always requires confirmation, regardless of agent policy
+
+---
+
+## Creating Custom Tools
+
+Delfhos makes it very easy to inject your own APIs, scraping scripts, or internal systems as tools. Define functions and decorate them with `@tool`.
+
+```python
+from delfhos import Agent, tool
+
+# Define your logic
+@tool(kind="read")
+async def check_inventory(product_id: str) -> str:
+    """Mock checking a product database."""
+    return f"Product {product_id} has 42 units in stock."
+
+# Pass it to the agent alongside built-in connections
+with Agent(
+    tools=[check_inventory],
+    system_prompt="You are a warehouse assistant."
+) as agent:
+    agent.run("How many units of product 12345 do we have?")
+```
+
+See **[examples/CustomTools/custom_tool_example.py](examples/CustomTools/custom_tool_example.py)** for a full script using `@tool`.
+
+---
+
+## Adding a Custom Connection
+
+If your tool requires OAuth or deep integration with the internal Cortex engine, follow the structure below and mirror patterns in `cortex/connections/` and `cortex/_engine/tools/`.
+
+In short, you need to create 4 things:
+
+```
+cortex/connections/slack.py     ← credentials + config
+cortex/tool_docs/slack.py       ← what the LLM knows about this tool
+cortex/_engine/tools/slack/     ← execution code (the actual API calls)
+```
+
+Then register it in `cortex/tool_docs/__init__.py`, `cortex/connections/__init__.py`, and `cortex/__init__.py`.
+
+For Google services, subclass `GoogleBaseConnection` instead of `BaseConnection` to get service account + OAuth support for free.
+
+---
+
+## Project Structure
+
+```
+delfhos/                         ← Public API (import from here)
+├── __init__.py                  # Agent + connections re-exports
+└── connections/
+    └── __init__.py              # All connection classes
+
+cortex/                          ← Internal engine
+├── __init__.py
+├── cortex.py                    # Cortex class (the agent)
+├── google_auth.py               # Google auth: scope mapping, SA/OAuth loaders
+│
+├── connections/                 # User-facing: one file per service
+│   ├── base.py                  # BaseConnection + GoogleBaseConnection
+│   ├── gmail.py
+│   ├── sql.py
+│   └── ...
+│
+├── tool_docs/                   # LLM prompt documentation for each tool
+│   ├── gmail.py                 # (ACTIONS, PYTHON_API, EXAMPLES)
+│   └── ...
+│
+└── _engine/                     # Internal engine (you don't need to touch this)
+    ├── agent.py                 # Orchestration loop
+    ├── connection.py            # Connection base class + manager
+    ├── internal/llm.py          # Multi-provider LLM abstraction
+    └── tools/                   # Tool executors (actual API call implementations)
+
+examples/
+├── Advanced/                    # Multi-tool and model comparison demos
+├── ChatMemory/                  # Chat memory and summarization demos
+├── CustomTools/                 # @tool and confirmation policy demos
+├── MCPTools/                    # MCP integration demos
+├── NativeTools/                 # Built-in Gmail/SQL/WebSearch flows
+└── PersistentMemory/            # Persistent memory demos
+
+tests/                           # Unit and integration-style automated tests
+```
+
+> **Note:** The `_engine/` directory is the internal implementation. You only need to look in there if you're adding execution code for a new tool.
+
+---
+
+## Publishing
+
+### PyPI package build and validation
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine check dist/*
+```
+
+### Upload to PyPI
+
+```bash
+# TestPyPI first (recommended)
+python -m twine upload --repository testpypi dist/*
+
+# Production PyPI
+python -m twine upload dist/*
+```
+
+### GitHub release checklist
+
+1. Ensure `pyproject.toml` version matches release tag (for example `v0.4.0`).
+2. Commit and push all release changes.
+3. Create and push an annotated git tag.
+4. Create a GitHub Release from that tag with highlights and migration notes.
+5. Validate install from a clean environment: `pip install delfhos==<version>`.
+
+---
+
+## License
+
+[Apache 2.0](LICENSE)