kadoa_sdk 0.3.1

Official Kadoa SDK for Python - Web data extraction and automation

Kadoa SDK for Python

Official Python SDK for the Kadoa API, providing easy integration with Kadoa's web data extraction platform.

Installation

pip install kadoa-sdk

Getting Started

Obtaining an API Key

1. Register at kadoa.com
2. Navigate to your account page
3. Copy your API key

Quick Start

from kadoa_sdk import initialize_app, run_extraction, KadoaConfig, ExtractionOptions

# Initialize the SDK
app = initialize_app(KadoaConfig(
    api_key="your-api-key"
))

# Run an extraction
result = run_extraction(app, ExtractionOptions(
    urls=["https://example.com"],
    name="My Extraction Workflow"
))

if result:
    print(f"Workflow created with ID: {result.workflow_id}")

Configuration

Basic Configuration

app = initialize_app(KadoaConfig(
    api_key="your-api-key",
    base_url="https://api.kadoa.com",  # optional
    timeout=30                         # optional, in seconds
))

Using Environment Variables

KADOA_API_KEY=your-api-key
KADOA_API_URL=https://api.kadoa.com
KADOA_TIMEOUT=30

import os
from dotenv import load_dotenv
from kadoa_sdk import initialize_app, KadoaConfig

load_dotenv()

app = initialize_app(KadoaConfig(
    api_key=os.environ["KADOA_API_KEY"],
    base_url=os.environ.get("KADOA_API_URL", "https://api.kadoa.com"),
    timeout=int(os.environ.get("KADOA_TIMEOUT", "30"))
))

API Reference

initialize_app(config: KadoaConfig)

• api_key (required): Your Kadoa API key
• base_url (optional): API base URL
• timeout (optional): Request timeout in seconds

Returns an app instance with configured API client.

run_extraction(app, options: ExtractionOptions)

• urls: List of URLs to extract from
• name: Workflow name
• Additional options available in API documentation

Examples

See examples directory for more usage examples.

Requirements

• Python 3.8+

License

MIT

Support

• Documentation: docs.kadoa.com
• Support: [e-mail]
• Issues: GitHub Issues