agents-function-tools 0.2.0__tar.gz → 0.3.0__tar.gz

{agents_function_tools-0.2.0/src/agents_function_tools.egg-info → agents_function_tools-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agents-function-tools
-Version: 0.2.0
+Version: 0.3.0
 Summary: Portable, policy-friendly system function tools for AI applications.
 License-Expression: Apache-2.0
 Classifier: Programming Language :: Python :: 3
@@ -18,16 +18,22 @@ Dynamic: license-file
 
 `agents-function-tools` is a portable Python library of policy-friendly system function tools. It contains no business model, Agent routing, domain workflow, database adapter, or code-review logic. Its Python import name is `function_tools`.
 
+## Install
+
+```bash
+python -m pip install agents-function-tools
+```
+
 ## Included tools
 
-| Category | Tools | Effect class |
+| Category | Tools | Tool group |
 |---|---|---|
-| Workspace read | List, read UTF-8, inspect metadata, glob-style find, hash files, disk usage | `safe_read` |
-| Workspace write | Write text, create directories, copy a regular file, move a path, delete a path | `workspace_write` |
-| ZIP | List archive entries; create and extract bounded ZIP archives | `safe_read` / `workspace_write` |
-| Network | Fetch bounded HTTPS text from configured hosts | `safe_read` |
-| Host | Non-sensitive system info, UTC time, explicitly allowlisted environment variables | `safe_read` |
-| Commands | Describe configured aliases; run one allowlisted executable with `shell=False` | `safe_read` / `workspace_execution` |
+| Workspace read | List, read UTF-8, inspect metadata, glob-style find, hash files, disk usage | `read` |
+| Workspace write | Write text, create directories, copy a regular file, move a path, delete a path | `write` |
+| ZIP | List archive entries; create and extract bounded ZIP archives | `read` / `write` |
+| Network | Fetch bounded HTTPS text from configured hosts | `read` |
+| Host | Non-sensitive system info, UTC time, explicitly allowlisted environment variables | `read` |
+| Commands | Describe configured aliases; run one allowlisted executable with `shell=False` | `read` / `execute` |
 
 Every tool returns the same JSON envelope with `ok`, `tool`, `effect`, `data`, and `error` fields. Paths are always relative to a configured workspace root.
 
@@ -43,19 +49,39 @@ Every tool returns the same JSON envelope with `ok`, `tool`, `effect`, `data`, a
 - Host diagnostics intentionally exclude user identities, process lists, network configuration, installed software, and environment variables except for names explicitly configured by the host.
 - Command execution accepts an argument array, never a shell string. Programs must be mapped by the host application, execution has a timeout, and output is truncated.
 - The local command runner is not an OS security sandbox. Production deployment must run the service or runner inside the company-approved container/sandbox with no production secrets and restricted network access.
-- Approval remains the orchestration layer's responsibility. Only expose `workspace_write` or `workspace_execution` tools to an Agent after the matching approval has been validated.
+- Approval remains the orchestration layer's responsibility. Only attach `tools.write` or `tools.execute` after the matching approval policy has been validated.
 
 This is a controlled operating-system capability adapter, not a general shell, process-management, credential, service-control, or unrestricted-network interface. Give each business Agent only the smallest subset of these tools it needs.
 
 ## Example
 
+```python
+from pathlib import Path
+
+from agents import Agent
+
+from function_tools import create_tools
+
+tools = create_tools(Path("./workspace"))
+
+agent = Agent(
+    name="Workspace assistant",
+    instructions="Use workspace tools when needed.",
+    tools=list(tools.read),
+)
+```
+
+`tools.read` is read-only. `tools.write` and `tools.execute` require approval on every call. The SDK derives each FunctionTool's input schema from the Python signature and docstring.
+
+For configured commands, HTTPS hosts, or readable environment variables, use `ToolConfig`:
+
 ```python
 import sys
 from pathlib import Path
 
-from function_tools.openai_tools import ToolConfig, create_function_tools
+from function_tools import ToolConfig, create_tools
 
-bundle = create_function_tools(
+tools = create_tools(
     ToolConfig(
         workspace_root=Path("./workspace"),
         command_programs={"python": sys.executable},
@@ -63,17 +89,8 @@ bundle = create_function_tools(
         environment_variables=frozenset({"APP_ENV"}),
     )
 )
-
-# Safe tools can be attached to an Agent immediately.
-safe_tools = list(bundle.safe_read)
-
-# Select side-effect tools only after the policy and approval checks pass.
-write_tools = list(bundle.workspace_write)
-execution_tools = list(bundle.workspace_execution)
 ```
 
-The SDK derives each FunctionTool's input schema from the Python signature and docstring. For production, keep the groups separate when attaching them to an Agent; do not use `bundle.all` by default.
-
 ## License
 
 Apache-2.0. See [LICENSE](LICENSE).
@@ -88,3 +105,19 @@ uv run --python 3.10 pytest
 ```
 
 Tests do not call the OpenAI API and do not require `OPENAI_API_KEY`.
+
+## Release acceptance
+
+Before every PyPI release, run:
+
+```powershell
+uv run python scripts/release_check.py
+```
+
+The gate checks the lockfile, formatting, linting, tests, wheel and source-distribution contents, package metadata, a clean `python -m pip install --no-deps <wheel>`, and a separate clean runtime installation with dependencies.
+
+Use the following command to run that gate and publish only when it passes:
+
+```powershell
+uv run python scripts/publish.py
+```

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/README.md

@@ -2,16 +2,22 @@
 
 `agents-function-tools` is a portable Python library of policy-friendly system function tools. It contains no business model, Agent routing, domain workflow, database adapter, or code-review logic. Its Python import name is `function_tools`.
 
+## Install
+
+```bash
+python -m pip install agents-function-tools
+```
+
 ## Included tools
 
-| Category | Tools | Effect class |
+| Category | Tools | Tool group |
 |---|---|---|
-| Workspace read | List, read UTF-8, inspect metadata, glob-style find, hash files, disk usage | `safe_read` |
-| Workspace write | Write text, create directories, copy a regular file, move a path, delete a path | `workspace_write` |
-| ZIP | List archive entries; create and extract bounded ZIP archives | `safe_read` / `workspace_write` |
-| Network | Fetch bounded HTTPS text from configured hosts | `safe_read` |
-| Host | Non-sensitive system info, UTC time, explicitly allowlisted environment variables | `safe_read` |
-| Commands | Describe configured aliases; run one allowlisted executable with `shell=False` | `safe_read` / `workspace_execution` |
+| Workspace read | List, read UTF-8, inspect metadata, glob-style find, hash files, disk usage | `read` |
+| Workspace write | Write text, create directories, copy a regular file, move a path, delete a path | `write` |
+| ZIP | List archive entries; create and extract bounded ZIP archives | `read` / `write` |
+| Network | Fetch bounded HTTPS text from configured hosts | `read` |
+| Host | Non-sensitive system info, UTC time, explicitly allowlisted environment variables | `read` |
+| Commands | Describe configured aliases; run one allowlisted executable with `shell=False` | `read` / `execute` |
 
 Every tool returns the same JSON envelope with `ok`, `tool`, `effect`, `data`, and `error` fields. Paths are always relative to a configured workspace root.
 
@@ -27,19 +33,39 @@ Every tool returns the same JSON envelope with `ok`, `tool`, `effect`, `data`, a
 - Host diagnostics intentionally exclude user identities, process lists, network configuration, installed software, and environment variables except for names explicitly configured by the host.
 - Command execution accepts an argument array, never a shell string. Programs must be mapped by the host application, execution has a timeout, and output is truncated.
 - The local command runner is not an OS security sandbox. Production deployment must run the service or runner inside the company-approved container/sandbox with no production secrets and restricted network access.
-- Approval remains the orchestration layer's responsibility. Only expose `workspace_write` or `workspace_execution` tools to an Agent after the matching approval has been validated.
+- Approval remains the orchestration layer's responsibility. Only attach `tools.write` or `tools.execute` after the matching approval policy has been validated.
 
 This is a controlled operating-system capability adapter, not a general shell, process-management, credential, service-control, or unrestricted-network interface. Give each business Agent only the smallest subset of these tools it needs.
 
 ## Example
 
+```python
+from pathlib import Path
+
+from agents import Agent
+
+from function_tools import create_tools
+
+tools = create_tools(Path("./workspace"))
+
+agent = Agent(
+    name="Workspace assistant",
+    instructions="Use workspace tools when needed.",
+    tools=list(tools.read),
+)
+```
+
+`tools.read` is read-only. `tools.write` and `tools.execute` require approval on every call. The SDK derives each FunctionTool's input schema from the Python signature and docstring.
+
+For configured commands, HTTPS hosts, or readable environment variables, use `ToolConfig`:
+
 ```python
 import sys
 from pathlib import Path
 
-from function_tools.openai_tools import ToolConfig, create_function_tools
+from function_tools import ToolConfig, create_tools
 
-bundle = create_function_tools(
+tools = create_tools(
     ToolConfig(
         workspace_root=Path("./workspace"),
         command_programs={"python": sys.executable},
@@ -47,17 +73,8 @@ bundle = create_function_tools(
         environment_variables=frozenset({"APP_ENV"}),
     )
 )
-
-# Safe tools can be attached to an Agent immediately.
-safe_tools = list(bundle.safe_read)
-
-# Select side-effect tools only after the policy and approval checks pass.
-write_tools = list(bundle.workspace_write)
-execution_tools = list(bundle.workspace_execution)
 ```
 
-The SDK derives each FunctionTool's input schema from the Python signature and docstring. For production, keep the groups separate when attaching them to an Agent; do not use `bundle.all` by default.
-
 ## License
 
 Apache-2.0. See [LICENSE](LICENSE).
@@ -72,3 +89,19 @@ uv run --python 3.10 pytest
 ```
 
 Tests do not call the OpenAI API and do not require `OPENAI_API_KEY`.
+
+## Release acceptance
+
+Before every PyPI release, run:
+
+```powershell
+uv run python scripts/release_check.py
+```
+
+The gate checks the lockfile, formatting, linting, tests, wheel and source-distribution contents, package metadata, a clean `python -m pip install --no-deps <wheel>`, and a separate clean runtime installation with dependencies.
+
+Use the following command to run that gate and publish only when it passes:
+
+```powershell
+uv run python scripts/publish.py
+```

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "agents-function-tools"
-version = "0.2.0"
+version = "0.3.0"
 description = "Portable, policy-friendly system function tools for AI applications."
 readme = "README.md"
 requires-python = ">=3.10"

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0/src/agents_function_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agents-function-tools
-Version: 0.2.0
+Version: 0.3.0
 Summary: Portable, policy-friendly system function tools for AI applications.
 License-Expression: Apache-2.0
 Classifier: Programming Language :: Python :: 3
@@ -18,16 +18,22 @@ Dynamic: license-file
 
 `agents-function-tools` is a portable Python library of policy-friendly system function tools. It contains no business model, Agent routing, domain workflow, database adapter, or code-review logic. Its Python import name is `function_tools`.
 
+## Install
+
+```bash
+python -m pip install agents-function-tools
+```
+
 ## Included tools
 
-| Category | Tools | Effect class |
+| Category | Tools | Tool group |
 |---|---|---|
-| Workspace read | List, read UTF-8, inspect metadata, glob-style find, hash files, disk usage | `safe_read` |
-| Workspace write | Write text, create directories, copy a regular file, move a path, delete a path | `workspace_write` |
-| ZIP | List archive entries; create and extract bounded ZIP archives | `safe_read` / `workspace_write` |
-| Network | Fetch bounded HTTPS text from configured hosts | `safe_read` |
-| Host | Non-sensitive system info, UTC time, explicitly allowlisted environment variables | `safe_read` |
-| Commands | Describe configured aliases; run one allowlisted executable with `shell=False` | `safe_read` / `workspace_execution` |
+| Workspace read | List, read UTF-8, inspect metadata, glob-style find, hash files, disk usage | `read` |
+| Workspace write | Write text, create directories, copy a regular file, move a path, delete a path | `write` |
+| ZIP | List archive entries; create and extract bounded ZIP archives | `read` / `write` |
+| Network | Fetch bounded HTTPS text from configured hosts | `read` |
+| Host | Non-sensitive system info, UTC time, explicitly allowlisted environment variables | `read` |
+| Commands | Describe configured aliases; run one allowlisted executable with `shell=False` | `read` / `execute` |
 
 Every tool returns the same JSON envelope with `ok`, `tool`, `effect`, `data`, and `error` fields. Paths are always relative to a configured workspace root.
 
@@ -43,19 +49,39 @@ Every tool returns the same JSON envelope with `ok`, `tool`, `effect`, `data`, a
 - Host diagnostics intentionally exclude user identities, process lists, network configuration, installed software, and environment variables except for names explicitly configured by the host.
 - Command execution accepts an argument array, never a shell string. Programs must be mapped by the host application, execution has a timeout, and output is truncated.
 - The local command runner is not an OS security sandbox. Production deployment must run the service or runner inside the company-approved container/sandbox with no production secrets and restricted network access.
-- Approval remains the orchestration layer's responsibility. Only expose `workspace_write` or `workspace_execution` tools to an Agent after the matching approval has been validated.
+- Approval remains the orchestration layer's responsibility. Only attach `tools.write` or `tools.execute` after the matching approval policy has been validated.
 
 This is a controlled operating-system capability adapter, not a general shell, process-management, credential, service-control, or unrestricted-network interface. Give each business Agent only the smallest subset of these tools it needs.
 
 ## Example
 
+```python
+from pathlib import Path
+
+from agents import Agent
+
+from function_tools import create_tools
+
+tools = create_tools(Path("./workspace"))
+
+agent = Agent(
+    name="Workspace assistant",
+    instructions="Use workspace tools when needed.",
+    tools=list(tools.read),
+)
+```
+
+`tools.read` is read-only. `tools.write` and `tools.execute` require approval on every call. The SDK derives each FunctionTool's input schema from the Python signature and docstring.
+
+For configured commands, HTTPS hosts, or readable environment variables, use `ToolConfig`:
+
 ```python
 import sys
 from pathlib import Path
 
-from function_tools.openai_tools import ToolConfig, create_function_tools
+from function_tools import ToolConfig, create_tools
 
-bundle = create_function_tools(
+tools = create_tools(
     ToolConfig(
         workspace_root=Path("./workspace"),
         command_programs={"python": sys.executable},
@@ -63,17 +89,8 @@ bundle = create_function_tools(
         environment_variables=frozenset({"APP_ENV"}),
     )
 )
-
-# Safe tools can be attached to an Agent immediately.
-safe_tools = list(bundle.safe_read)
-
-# Select side-effect tools only after the policy and approval checks pass.
-write_tools = list(bundle.workspace_write)
-execution_tools = list(bundle.workspace_execution)
 ```
 
-The SDK derives each FunctionTool's input schema from the Python signature and docstring. For production, keep the groups separate when attaching them to an Agent; do not use `bundle.all` by default.
-
 ## License
 
 Apache-2.0. See [LICENSE](LICENSE).
@@ -88,3 +105,19 @@ uv run --python 3.10 pytest
 ```
 
 Tests do not call the OpenAI API and do not require `OPENAI_API_KEY`.
+
+## Release acceptance
+
+Before every PyPI release, run:
+
+```powershell
+uv run python scripts/release_check.py
+```
+
+The gate checks the lockfile, formatting, linting, tests, wheel and source-distribution contents, package metadata, a clean `python -m pip install --no-deps <wheel>`, and a separate clean runtime installation with dependencies.
+
+Use the following command to run that gate and publish only when it passes:
+
+```powershell
+uv run python scripts/publish.py
+```

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/src/agents_function_tools.egg-info/SOURCES.txt

@@ -19,4 +19,5 @@ tests/test_archive.py
 tests/test_command.py
 tests/test_host_and_http.py
 tests/test_openai_tools.py
+tests/test_public_api.py
 tests/test_workspace.py

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/src/function_tools/__init__.py

@@ -5,17 +5,22 @@ from .command import CommandPolicy, LocalCommandRunner
 from .errors import FoundationToolError
 from .host import HostInspector
 from .http import HttpPolicy, HttpTextClient
+from .openai_tools import FunctionToolBundle, ToolConfig, create_function_tools, create_tools
 from .workspace import Workspace
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 __all__ = [
     "CommandPolicy",
     "FoundationToolError",
+    "FunctionToolBundle",
     "HostInspector",
     "HttpPolicy",
     "HttpTextClient",
     "LocalCommandRunner",
+    "ToolConfig",
     "Workspace",
     "ZipArchive",
+    "create_function_tools",
+    "create_tools",
 ]

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/src/function_tools/http.py

@@ -43,7 +43,7 @@ class HttpTextClient:
         request = Request(
             url,
             headers={
-                "User-Agent": "company-agent-service/0.1",
+                "User-Agent": "agents-function-tools/0.3.0",
                 "Accept": "text/plain,text/html,application/json",
             },
         )

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/src/function_tools/openai_tools.py

@@ -18,7 +18,7 @@ from .workspace import Workspace
 
 @dataclass(frozen=True)
 class ToolConfig:
-    workspace_root: Path
+    workspace_root: Path | str
     command_programs: Mapping[str, str] = field(default_factory=dict)
     max_read_bytes: int = 1_000_000
     max_write_bytes: int = 1_000_000
@@ -39,8 +39,30 @@ class FunctionToolBundle:
     workspace_execution: tuple[Any, ...]
 
     @property
-    def all(self) -> tuple[Any, ...]:
-        return self.safe_read + self.workspace_write + self.workspace_execution
+    def read(self) -> tuple[Any, ...]:
+        """Read-only tools that can be attached without an approval request."""
+
+        return self.safe_read
+
+    @property
+    def write(self) -> tuple[Any, ...]:
+        """Workspace-mutating tools that require approval for every call."""
+
+        return self.workspace_write
+
+    @property
+    def execute(self) -> tuple[Any, ...]:
+        """Local command tools that require approval for every call."""
+
+        return self.workspace_execution
+
+
+def create_tools(config: ToolConfig | Path | str) -> FunctionToolBundle:
+    """Create tools from a full policy config or a workspace path with safe defaults."""
+
+    if not isinstance(config, ToolConfig):
+        config = ToolConfig(workspace_root=config)
+    return create_function_tools(config)
 
 
 def create_function_tools(config: ToolConfig) -> FunctionToolBundle:

{agents_function_tools-0.2.0 → agents_function_tools-0.3.0}/tests/test_openai_tools.py

@@ -6,7 +6,7 @@ from pathlib import Path
 
 from agents.tool_context import ToolContext
 
-from function_tools.openai_tools import ToolConfig, create_function_tools
+from function_tools import ToolConfig, create_function_tools, create_tools
 
 
 def test_sdk_tools_are_grouped_by_effect(tmp_path: Path) -> None:
@@ -38,6 +38,16 @@ def test_sdk_tools_are_grouped_by_effect(tmp_path: Path) -> None:
     assert {tool.name for tool in bundle.workspace_execution} == {"run_local_command"}
     assert all(tool.needs_approval is True for tool in bundle.workspace_write)
     assert all(tool.needs_approval is True for tool in bundle.workspace_execution)
+    assert bundle.read == bundle.safe_read
+    assert bundle.write == bundle.workspace_write
+    assert bundle.execute == bundle.workspace_execution
+    assert not hasattr(bundle, "all")
+
+
+def test_create_tools_accepts_a_workspace_path(tmp_path: Path) -> None:
+    bundle = create_tools(tmp_path)
+
+    assert bundle.read
 
 
 def test_tool_error_uses_standard_response(tmp_path: Path) -> None:

agents_function_tools-0.3.0/tests/test_public_api.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+import function_tools
+
+
+def test_top_level_api_exposes_the_quick_start() -> None:
+    assert function_tools.__version__ == "0.3.0"
+    assert callable(function_tools.create_tools)
+    assert callable(function_tools.create_function_tools)
+    assert function_tools.ToolConfig.__name__ == "ToolConfig"