b6b4cd0a4c
### Overview Major restructuring from monolithic `arcade-ai` package to modular library architecture with standardized uv-based dependency management.  ### New Package Structure - **`arcade-tdk`** - Lightweight toolkit development kit (core decorators, auth) - **`arcade-core`** - Core execution engine and catalog functionality - **`arcade-serve`** - FastAPI/MCP server components - **`arcade-ai`** - Meta package that includes CLI functionality. Optionally include evals via the `evals` extra. Optionally include all packages via the `all` extra. ### Key Benefits - **Lighter Dependencies**: Toolkits now depend only on `arcade-tdk` (~2 deps) vs full `arcade-ai` (~30+ deps) - **Faster Builds**: uv provides 10-100x faster dependency resolution and installation - **Better Modularity**: Clear separation of concerns, consumers import only what they need - **Standard Tooling**: Eliminates custom poetry scripts, uses standard Python packaging ### Migration Impact - All 20 toolkits converted from poetry → uv with `arcade-tdk` dependencies plus `arcade-ai[evals]` and `arcade-serve` dev dependencies. When developing locally, devs should install toolkits via `make install-local`. - Modern Python 3.10+ type hints throughout - Standardized build system with hatchling backend - Enhanced Makefile with robust toolkit management commands - Removed `arcade dev` CLI command - Reduce the number of files created by `arcade new` and add an option to not generate a tests and evals folder. This foundation enables faster development cycles and cleaner dependency chains for the growing toolkit ecosystem. ### Todo After this PR is merged - [ ] Post-merge workflow(s) (release & publish containers, etc) - [ ] Release order plan. @EricGustin suggests releasing in the following order: 1. `arcade-core` version 0.1.0 2. `arcade-serve` version 0.1.0 and `arcade-tdk` version 0.1.0 3. `arcade-ai` version 2.0.0 4. Patch release for all toolkits (all changes in toolkits are internal refactors) - [ ] [Update docs](https://github.com/ArcadeAI/docs/pull/318) --------- Co-authored-by: Eric Gustin <eric@arcade.dev> Co-authored-by: Eric Gustin <34000337+EricGustin@users.noreply.github.com>
93 lines
2.3 KiB
Python
93 lines
2.3 KiB
Python
from abc import ABC, abstractmethod
|
|
from typing import Any, Callable
|
|
|
|
from arcade_core.schema import ToolCallRequest, ToolCallResponse, ToolDefinition
|
|
from pydantic import BaseModel
|
|
|
|
CatalogResponse = list[ToolDefinition]
|
|
HealthCheckResponse = dict[str, str]
|
|
JSONResponse = dict[str, Any]
|
|
ResponseData = CatalogResponse | ToolCallResponse | HealthCheckResponse
|
|
|
|
|
|
class RequestData(BaseModel):
|
|
"""
|
|
The raw data for a request to a worker.
|
|
This is not intended to represent everything about an HTTP request,
|
|
but just the essential info a framework integration will need to extract from the request.
|
|
"""
|
|
|
|
path: str
|
|
"""The path of the request."""
|
|
method: str
|
|
"""The method of the request."""
|
|
body_json: JSONResponse | None = None
|
|
"""The deserialized body of the request (e.g. JSON)"""
|
|
|
|
|
|
class Router(ABC):
|
|
"""
|
|
A router is responsible for adding routes to the underlying framework hosting the worker.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def add_route(
|
|
self,
|
|
endpoint_path: str,
|
|
handler: Callable,
|
|
method: str,
|
|
require_auth: bool = True,
|
|
response_type: type[ResponseData] | None = None,
|
|
**kwargs: Any,
|
|
) -> None:
|
|
"""
|
|
Add a route to the router.
|
|
"""
|
|
pass
|
|
|
|
|
|
class Worker(ABC):
|
|
"""
|
|
A Worker represents a collection of tools that is hosted inside a web framework
|
|
and can be called by an Engine.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def get_catalog(self) -> CatalogResponse:
|
|
"""
|
|
Get the catalog of tools available in the worker.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def call_tool(self, request: ToolCallRequest) -> ToolCallResponse:
|
|
"""
|
|
Send a request to call a tool to the Worker
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def health_check(self) -> HealthCheckResponse:
|
|
"""
|
|
Perform a health check of the worker
|
|
"""
|
|
pass
|
|
|
|
|
|
class WorkerComponent(ABC):
|
|
def __init__(self, worker: Worker) -> None:
|
|
self.worker = worker
|
|
|
|
@abstractmethod
|
|
def register(self, router: Router) -> None:
|
|
"""
|
|
Register the component with the given router.
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
async def __call__(self, request: RequestData) -> ResponseData:
|
|
"""
|
|
Handle the request.
|
|
"""
|
|
pass
|