Skip to content

README.md

Latest commit

 

History

History
72 lines (50 loc) · 3.53 KB

README.md

File metadata and controls

72 lines (50 loc) · 3.53 KB

Integrations SDK for Autohive

Tests Coverage PyPI version Python License: MIT

Overview

This is the SDK for building integrations into Autohive's AI agent platform.

Getting Started

Start with the Building Your First Integration tutorial, or copy the starter template to hit the ground running.

Documentation

Guide Description
Building Your First Integration End-to-end tutorial covering config, actions, auth, testing
Integration Structure Directory layout, config.json schema reference, naming conventions
Patterns & Best Practices Pagination, API helpers, multi-field auth
Billing & Cost Tracking Reporting per-action costs via ActionResult.cost_usd
Connected Accounts Fetching and displaying external account info
API Reference Generated API docs (pdoc)

Samples

Sample Description
samples/template/ Clean starter template — copy this to begin a new integration
samples/api-fetch/ Working example with unauthenticated, Basic Auth, and Bearer token API calls
samples/action-error-demo/ Demonstrates ActionError for expected application-level errors

Testing

Install test dependencies:

pip install -e ".[test]"

Run tests:

python -m pytest tests/ -v

Run with coverage:

python -m pytest tests/ -v --cov=autohive_integrations_sdk --cov-report=term-missing

CI runs automatically on PRs via GitHub Actions — see .github/workflows/tests.yml.

Validation & CI

Integration validation is handled by the autohive-integrations-tooling repo. See its README for CI pipeline setup and the integration checklist.

Agent Skills

The skills/ directory contains agent skills for AI coding assistants (Amp, Claude Code, etc.) that automate common SDK tasks.

Skill Description
upgrading-sdk-v2 Upgrades an integration from SDK 1.x to 2.0.0 — covers source code, tests, requirements, and config

To use a skill, copy or symlink it into your workspace's .agents/skills/ directory or your global ~/.config/agents/skills/ directory. See skills/README.md for setup instructions.

Additional Information