arcade-core 4.0.0__tar.gz

arcade_core-4.0.0/.gitignore

@@ -0,0 +1,181 @@
+.DS_Store
+credentials.yaml
+docker/credentials.yaml
+
+*.lock
+
+# example data
+examples/data
+scratch
+
+
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# IDE
+*.code-workspace
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Docs
+libs/arcade-mcp-server/site/*

arcade_core-4.0.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.4
+Name: arcade-core
+Version: 4.0.0
+Summary: Arcade Core - Core library for Arcade platform
+Author-email: Arcade <dev@arcade.dev>
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: packaging>=24.1
+Requires-Dist: pydantic>=2.7.0
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: toml>=0.10.2
+Requires-Dist: types-python-dateutil==2.9.0.20241003
+Requires-Dist: types-pytz==2024.2.0.20241003
+Requires-Dist: types-toml==0.10.8.20240310
+Provides-Extra: dev
+Requires-Dist: mypy>=1.5.1; extra == 'dev'
+Requires-Dist: pre-commit>=3.4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.7; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.1.2; extra == 'dev'
+Requires-Dist: types-python-dateutil>=2.8.2; extra == 'dev'
+Requires-Dist: types-pytz>=2024.1; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Arcade Core
+
+Core library for the Arcade platform providing foundational components and utilities.
+
+## Overview
+
+Arcade Core provides the essential building blocks for the Arcade platform:
+
+- **Tool Catalog & Toolkit Management**: Core classes for managing and organizing tools
+- **Configuration & Schema Handling**: Configuration management and validation
+- **Authentication & Authorization**: Auth providers and security utilities
+- **Error Handling**: Comprehensive error types and handling
+- **Telemetry & Observability**: Monitoring and tracing capabilities
+- **Utilities**: Common helper functions and validators
+
+## Installation
+
+```bash
+pip install arcade-core
+```
+
+## Usage
+
+1. Install an arcade toolkit
+```bash
+pip install arcade-math
+```
+
+2. Load the toolkit
+```python
+import arcade_math
+from arcade_core import ToolCatalog, Toolkit
+
+# Create a tool catalog
+catalog = ToolCatalog()
+
+# Load a toolkit
+toolkit = Toolkit.from_module(arcade_math)
+```
+
+## License
+
+MIT License - see LICENSE file for details.

arcade_core-4.0.0/README.md

@@ -0,0 +1,43 @@
+# Arcade Core
+
+Core library for the Arcade platform providing foundational components and utilities.
+
+## Overview
+
+Arcade Core provides the essential building blocks for the Arcade platform:
+
+- **Tool Catalog & Toolkit Management**: Core classes for managing and organizing tools
+- **Configuration & Schema Handling**: Configuration management and validation
+- **Authentication & Authorization**: Auth providers and security utilities
+- **Error Handling**: Comprehensive error types and handling
+- **Telemetry & Observability**: Monitoring and tracing capabilities
+- **Utilities**: Common helper functions and validators
+
+## Installation
+
+```bash
+pip install arcade-core
+```
+
+## Usage
+
+1. Install an arcade toolkit
+```bash
+pip install arcade-math
+```
+
+2. Load the toolkit
+```python
+import arcade_math
+from arcade_core import ToolCatalog, Toolkit
+
+# Create a tool catalog
+catalog = ToolCatalog()
+
+# Load a toolkit
+toolkit = Toolkit.from_module(arcade_math)
+```
+
+## License
+
+MIT License - see LICENSE file for details.

arcade_core-4.0.0/arcade_core/__init__.py

@@ -0,0 +1,2 @@
+from .catalog import ToolCatalog as ToolCatalog
+from .toolkit import Toolkit as Toolkit

arcade_core-4.0.0/arcade_core/annotations.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Inferrable:
+    """An annotation indicating that a parameter can be inferred by a model (default: True)."""
+
+    value: bool = True

arcade_core-4.0.0/arcade_core/auth.py

@@ -0,0 +1,204 @@
+from enum import Enum
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict
+
+
+class AuthProviderType(str, Enum):
+    oauth2 = "oauth2"
+
+
+class ToolAuthorization(BaseModel):
+    """Marks a tool as requiring authorization."""
+
+    model_config = ConfigDict(frozen=True)
+
+    provider_id: Optional[str] = None
+    """The provider ID configured in Arcade that acts as an alias to well-known configuration."""
+
+    provider_type: AuthProviderType
+    """The type of the authorization provider."""
+
+    id: Optional[str] = None
+    """A provider's unique identifier, allowing the tool to specify a specific authorization provider. Recommended for private tools only."""
+
+    scopes: Optional[list[str]] = None
+    """The scope(s) needed for the authorized action."""
+
+
+class OAuth2(ToolAuthorization):
+    """Marks a tool as requiring OAuth 2.0 authorization."""
+
+    def __init__(self, *, id: str | None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes, provider_type=AuthProviderType.oauth2)
+
+
+class Asana(OAuth2):
+    """Marks a tool as requiring Asana authorization."""
+
+    provider_id: str = "asana"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Atlassian(OAuth2):
+    """Marks a tool as requiring Atlassian authorization."""
+
+    provider_id: str = "atlassian"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class ClickUp(OAuth2):
+    """Marks a tool as requiring ClickUp authorization."""
+
+    provider_id: str = "clickup"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Discord(OAuth2):
+    """Marks a tool as requiring Discord authorization."""
+
+    provider_id: str = "discord"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Dropbox(OAuth2):
+    """Marks a tool as requiring Dropbox authorization."""
+
+    provider_id: str = "dropbox"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Figma(OAuth2):
+    """Marks a tool as requiring Figma authorization."""
+
+    provider_id: str = "figma"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class GitHub(OAuth2):
+    """Marks a tool as requiring GitHub App authorization."""
+
+    provider_id: str = "github"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Google(OAuth2):
+    """Marks a tool as requiring Google authorization."""
+
+    provider_id: str = "google"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Hubspot(OAuth2):
+    """Marks a tool as requiring Hubspot authorization."""
+
+    provider_id: str = "hubspot"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Linear(OAuth2):
+    """Marks a tool as requiring Linear authorization."""
+
+    provider_id: str = "linear"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class LinkedIn(OAuth2):
+    """Marks a tool as requiring LinkedIn authorization."""
+
+    provider_id: str = "linkedin"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Microsoft(OAuth2):
+    """Marks a tool as requiring Microsoft authorization."""
+
+    provider_id: str = "microsoft"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Notion(OAuth2):
+    """Marks a tool as requiring Notion authorization."""
+
+    provider_id: str = "notion"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Reddit(OAuth2):
+    """Marks a tool as requiring Reddit authorization."""
+
+    provider_id: str = "reddit"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Slack(OAuth2):
+    """Marks a tool as requiring Slack (user token) authorization."""
+
+    provider_id: str = "slack"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Spotify(OAuth2):
+    """Marks a tool as requiring Spotify authorization."""
+
+    provider_id: str = "spotify"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Twitch(OAuth2):
+    """Marks a tool as requiring Twitch authorization."""
+
+    provider_id: str = "twitch"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class X(OAuth2):
+    """Marks a tool as requiring X (Twitter) authorization."""
+
+    provider_id: str = "x"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)
+
+
+class Zoom(OAuth2):
+    """Marks a tool as requiring Zoom authorization."""
+
+    provider_id: str = "zoom"
+
+    def __init__(self, *, id: Optional[str] = None, scopes: Optional[list[str]] = None):  # noqa: A002
+        super().__init__(id=id, scopes=scopes)

arcade_core-4.0.0/arcade_core/auth_tokens.py

@@ -0,0 +1,110 @@
+"""
+Shared access-token utilities used by both the CLI and MCP server.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime, timedelta
+
+import httpx
+from pydantic import BaseModel
+
+from arcade_core.config_model import Config
+from arcade_core.constants import PROD_COORDINATOR_HOST
+
+
+class CLIConfig(BaseModel):
+    """OAuth configuration returned by the Coordinator."""
+
+    client_id: str
+    authorization_endpoint: str
+    token_endpoint: str
+
+
+class TokenResponse(BaseModel):
+    """OAuth token response."""
+
+    access_token: str
+    refresh_token: str
+    expires_in: int
+    token_type: str
+
+
+def fetch_cli_config(coordinator_url: str) -> CLIConfig:
+    """Fetch OAuth configuration from the Coordinator."""
+    url = f"{coordinator_url}/api/v1/auth/cli_config"
+    response = httpx.get(url, timeout=30)
+    response.raise_for_status()
+    return CLIConfig.model_validate(response.json())
+
+
+def refresh_access_token(
+    cli_config: CLIConfig,
+    refresh_token: str,
+) -> TokenResponse:
+    """Refresh the access token using authlib-compatible token endpoint."""
+    response = httpx.post(
+        cli_config.token_endpoint,
+        data={
+            "grant_type": "refresh_token",
+            "refresh_token": refresh_token,
+            "client_id": cli_config.client_id,
+        },
+        timeout=30,
+    )
+    response.raise_for_status()
+    token = response.json()
+    return TokenResponse(
+        access_token=token["access_token"],
+        refresh_token=token.get("refresh_token", refresh_token),
+        expires_in=token["expires_in"],
+        token_type=token["token_type"],
+    )
+
+
+def get_valid_access_token(coordinator_url: str | None = None) -> str:
+    """
+    Get a valid access token, refreshing if necessary.
+
+    Returns:
+        Valid access token
+
+    Raises:
+        ValueError: If not logged in or token refresh fails
+    """
+    try:
+        config = Config.load_from_file()
+    except FileNotFoundError:
+        raise ValueError("Not logged in. Please run 'arcade login' first.")
+
+    resolved_coordinator_url = (
+        coordinator_url
+        or (config.coordinator_url if config.coordinator_url else None)
+        or f"https://{PROD_COORDINATOR_HOST}"
+    )
+
+    if not config.auth:
+        raise ValueError("Not logged in. Please run 'arcade login' first.")
+
+    # Check if token needs refresh
+    if config.is_token_expired():
+        cli_config = fetch_cli_config(resolved_coordinator_url)
+
+        try:
+            new_tokens = refresh_access_token(cli_config, config.auth.refresh_token)
+        except httpx.HTTPError as e:
+            raise ValueError(
+                f"Failed to refresh token: {e}. Please run 'arcade login' to re-authenticate."
+            )
+
+        # Update stored credentials
+        expires_at = datetime.now() + timedelta(seconds=new_tokens.expires_in)
+        config.coordinator_url = resolved_coordinator_url
+        config.auth.access_token = new_tokens.access_token
+        config.auth.refresh_token = new_tokens.refresh_token
+        config.auth.expires_at = expires_at
+        config.save_to_file()
+
+        return new_tokens.access_token
+
+    return config.auth.access_token