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>
120 lines
4.7 KiB
Markdown
120 lines
4.7 KiB
Markdown
<h3 align="center">
|
|
<a name="readme-top"></a>
|
|
<img
|
|
src="https://docs.arcade.dev/images/logo/arcade-logo.png"
|
|
style="width: 400px;"
|
|
>
|
|
</h3>
|
|
<div align="center">
|
|
<a href="https://github.com/arcadeai/arcade-ai/blob/main/LICENSE">
|
|
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
|
|
</a>
|
|
<img src="https://img.shields.io/github/last-commit/ArcadeAI/arcade-ai" alt="GitHub last commit">
|
|
</a>
|
|
<a href="https://github.com/arcadeai/arcade-ai/actions/workflow/on-release-main.yml">
|
|
<img src="https://img.shields.io/github/actions/workflow/status/arcadeai/arcade-ai/check-toolkits.yml" alt="GitHub Actions Status">
|
|
</a>
|
|
<a href="https://img.shields.io/pypi/pyversions/arcade-ai">
|
|
<img src="https://img.shields.io/pypi/pyversions/arcade-ai" alt="Python Version">
|
|
</a>
|
|
</div>
|
|
<div>
|
|
<p align="center" style="display: flex; justify-content: center; gap: 10px;">
|
|
<a href="https://x.com/TryArcade">
|
|
<img src="https://img.shields.io/badge/Follow%20on%20X-000000?style=for-the-badge&logo=x&logoColor=white" alt="Follow on X" style="width: 125px;height: 25px; padding-top: .8px; border-radius: 5px;" />
|
|
</a>
|
|
<a href="https://www.linkedin.com/company/arcade-ai" >
|
|
<img src="https://img.shields.io/badge/Follow%20on%20LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" alt="Follow on LinkedIn" style="width: 150px; padding-top: 1.5px;height: 22px; border-radius: 5px;" />
|
|
</a>
|
|
<a href="https://discord.com/invite/GUZEMpEZ9p">
|
|
<img src="https://img.shields.io/badge/Join%20our%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white" alt="Join our Discord" style="width: 150px; padding-top: 1.5px; height: 22px; border-radius: 5px;" />
|
|
</a>
|
|
</p>
|
|
</div>
|
|
|
|
<p align="center" style="display: flex; justify-content: center; gap: 5px; font-size: 15px;">
|
|
<a href="https://docs.arcade.dev/home" target="_blank">Documentation</a> •
|
|
<a href="https://docs.arcade.dev/tools" target="_blank">Tools</a> •
|
|
<a href="https://docs.arcade.dev/home/quickstart" target="_blank">Quickstart</a> •
|
|
<a href="https://docs.arcade.dev/home/contact-us" target="_blank">Contact Us</a>
|
|
|
|
# Arcade AI Platform
|
|
|
|
Arcade is a developer platform that lets you build, deploy, and manage tools for AI agents.
|
|
|
|
This repository contains the core Arcade libraries, organized as separate packages for maximum flexibility and modularity:
|
|
|
|
- [**`arcade-core`**](libs/arcade-core) - Core platform functionality and schemas
|
|
- [**`arcade-tdk`**](libs/arcade-tdk) - Tool Development Kit with the `@tool` decorator
|
|
- [**`arcade-serve`**](libs/arcade-serve) - Serving infrastructure for workers and MCP servers
|
|
- [**`arcade-evals`**](libs/arcade-evals) - Evaluation framework for testing tool performance
|
|
- [**`arcade-cli`**](libs/arcade-cli) - Command-line interface for the Arcade platform
|
|
|
|
|
|
|
|
**To learn more about Arcade.dev, check out our [documentation](https://docs.arcade.dev/home).**
|
|
|
|
_Pst. hey, you, give us a star if you like it!_
|
|
|
|
<a href="https://github.com/ArcadeAI/arcade-ai">
|
|
<img src="https://img.shields.io/github/stars/ArcadeAI/arcade-ai.svg" alt="GitHub stars">
|
|
</a>
|
|
|
|
## Quick Start
|
|
|
|
### Installation
|
|
|
|
For development, install all packages with dependencies using uv workspace:
|
|
|
|
```bash
|
|
# Install all packages and dev dependencies
|
|
uv sync --extra all --dev
|
|
|
|
# Or use the Makefile (includes pre-commit hooks)
|
|
make install
|
|
```
|
|
|
|
For production use, install individual packages as needed:
|
|
|
|
```bash
|
|
pip install arcade-ai # CLI
|
|
pip install 'arcade-ai[evals]' # CLI + Evaluation framework
|
|
pip install 'arcade-ai[all]' # CLI + Serving infra + eval framework + TDK
|
|
pip install arcade_serve # Serving infrastructure
|
|
pip install arcade-tdk # Tool Development Kit
|
|
```
|
|
|
|
### Development
|
|
|
|
Use the Makefile for standard tasks:
|
|
|
|
```bash
|
|
# Run tests
|
|
make test
|
|
|
|
# Run linting and type checking
|
|
make check
|
|
|
|
# Build all packages
|
|
make build
|
|
|
|
# See all available commands
|
|
make help
|
|
```
|
|
|
|
## Client Libraries
|
|
|
|
- **[ArcadeAI/arcade-py](https://github.com/ArcadeAI/arcade-py):**
|
|
The Python client for interacting with Arcade.
|
|
|
|
- **[ArcadeAI/arcade-js](https://github.com/ArcadeAI/arcade-js):**
|
|
The JavaScript client for interacting with Arcade.
|
|
|
|
- **[ArcadeAI/arcade-go](https://github.com/ArcadeAI/arcade-go):**
|
|
The Go client for interacting with Arcade.
|
|
|
|
## Support and Community
|
|
|
|
- **Discord:** Join our [Discord community](https://discord.com/invite/GUZEMpEZ9p) for real-time support and discussions.
|
|
- **GitHub:** Contribute or report issues on the [Arcade GitHub repository](https://github.com/ArcadeAI/arcade-ai).
|
|
- **Documentation:** Find in-depth guides and API references at [Arcade Documentation](https://docs.arcade.dev).
|