| Name | kadoa-sdk JSON |
| Version |
0.6.0
JSON |
| download |
| home_page | None |
| Summary | Official Kadoa SDK for Python - Web data extraction and automation |
| upload_time | 2025-09-08 07:19:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
kadoa
api
sdk
client
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Kadoa SDK for Python
Official Python SDK for the Kadoa API, providing easy integration with Kadoa's web data extraction platform.
## Installation
We recommend using a virtual environment to avoid dependency conflicts (optional). Use your preferred tool (`venv`, `virtualenv`, `conda`, `poetry`, `uv`).
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install kadoa-sdk
```
## Getting Started
### Obtaining an API Key
1. Register at [kadoa.com](https://www.kadoa.com/)
2. Navigate to your [account page](https://www.kadoa.com/account)
3. Copy your API key
### Quick Start
```python
import logging
from kadoa_sdk import KadoaClient, KadoaClientConfig, ExtractionOptions
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger("kadoa_sdk.examples")
# Initialize the client
client = KadoaClient(KadoaClientConfig(
api_key="your-api-key"
))
# Run an extraction
result = client.extraction.run(ExtractionOptions(
urls=["https://example.com"],
name="My Extraction Workflow"
))
if result:
logger.info("Workflow created with ID: %s", result.workflow_id)
```
## Configuration
### Basic Configuration
```python
client = KadoaClient(KadoaClientConfig(
api_key="your-api-key",
base_url="https://api.kadoa.com", # optional
timeout=30 # optional, in seconds
))
```
### Using Environment Variables
```env
KADOA_API_KEY=your-api-key
KADOA_API_URL=https://api.kadoa.com
KADOA_TIMEOUT=30
```
```python
import os
from dotenv import load_dotenv
from kadoa_sdk import KadoaClient, KadoaClientConfig
load_dotenv()
client = KadoaClient(KadoaClientConfig(
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"))
))
```
## Event Handling
```python
import logging
from kadoa_sdk import KadoaClient, KadoaClientConfig
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger("kadoa_sdk.examples")
client = KadoaClient(KadoaClientConfig(api_key="your-api-key"))
# Listen to events with a lambda and log output
client.on_event(lambda e: logger.info("event: %s", e.to_dict()))
# Event types:
# - entity:detected
# - extraction:started
# - extraction:status_changed
# - extraction:data_available
# - extraction:completed
```
## API Reference
### KadoaClient(config: KadoaClientConfig)
- `api_key` (required): Your Kadoa API key
- `base_url` (optional): API base URL (default: 'https://api.kadoa.com')
- `timeout` (optional): Request timeout in seconds (default: 30)
Returns a client instance with:
- `extraction`: Extraction module with `run()` method
- `on_event()`: Subscribe to events
- `off_event()`: Unsubscribe from events
- `dispose()`: Releases resources and removes all event listeners
### client.extraction.run(options: ExtractionOptions)
- `urls`: List of URLs to extract from
- `name`: Workflow name
- Additional options available in API documentation
## Examples
See [examples directory](https://github.com/kadoa-org/kadoa-sdks/tree/main/examples/python-examples) for more usage examples.
## Requirements
- Python 3.8+
## License
MIT
## Support
- Documentation: [docs.kadoa.com](https://docs.kadoa.com)
- Support: [support@kadoa.com](mailto:support@kadoa.com)
- Issues: [GitHub Issues](https://github.com/kadoa-org/kadoa-sdks/issues)
- Changelog: [CHANGELOG.md](./CHANGELOG.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "kadoa-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "kadoa, api, sdk, client, python",
"author": null,
"author_email": "Kadoa <support@kadoa.com>",
"download_url": "https://files.pythonhosted.org/packages/fd/af/3355064ea817007d22285130ddcbabfedda2c5558a1455a845eb6f5f7994/kadoa_sdk-0.6.0.tar.gz",
"platform": null,
"description": "# Kadoa SDK for Python\n\nOfficial Python SDK for the Kadoa API, providing easy integration with Kadoa's web data extraction platform.\n\n## Installation\n\nWe recommend using a virtual environment to avoid dependency conflicts (optional). Use your preferred tool (`venv`, `virtualenv`, `conda`, `poetry`, `uv`).\n\n```bash\npython3 -m venv .venv\nsource .venv/bin/activate\npip install kadoa-sdk\n```\n\n## Getting Started\n\n### Obtaining an API Key\n\n1. Register at [kadoa.com](https://www.kadoa.com/)\n2. Navigate to your [account page](https://www.kadoa.com/account)\n3. Copy your API key\n\n### Quick Start\n\n```python\nimport logging\nfrom kadoa_sdk import KadoaClient, KadoaClientConfig, ExtractionOptions\n\nlogging.basicConfig(level=logging.INFO)\nlogger = logging.getLogger(\"kadoa_sdk.examples\")\n\n# Initialize the client\nclient = KadoaClient(KadoaClientConfig(\n api_key=\"your-api-key\"\n))\n\n# Run an extraction\nresult = client.extraction.run(ExtractionOptions(\n urls=[\"https://example.com\"],\n name=\"My Extraction Workflow\"\n))\n\nif result:\n logger.info(\"Workflow created with ID: %s\", result.workflow_id)\n```\n\n## Configuration\n\n### Basic Configuration\n\n```python\nclient = KadoaClient(KadoaClientConfig(\n api_key=\"your-api-key\",\n base_url=\"https://api.kadoa.com\", # optional\n timeout=30 # optional, in seconds\n))\n```\n\n### Using Environment Variables\n\n```env\nKADOA_API_KEY=your-api-key\nKADOA_API_URL=https://api.kadoa.com\nKADOA_TIMEOUT=30\n```\n\n```python\nimport os\nfrom dotenv import load_dotenv\nfrom kadoa_sdk import KadoaClient, KadoaClientConfig\n\nload_dotenv()\n\nclient = KadoaClient(KadoaClientConfig(\n api_key=os.environ[\"KADOA_API_KEY\"],\n base_url=os.environ.get(\"KADOA_API_URL\", \"https://api.kadoa.com\"),\n timeout=int(os.environ.get(\"KADOA_TIMEOUT\", \"30\"))\n))\n```\n\n## Event Handling\n\n```python\nimport logging\nfrom kadoa_sdk import KadoaClient, KadoaClientConfig\n\nlogging.basicConfig(level=logging.INFO)\nlogger = logging.getLogger(\"kadoa_sdk.examples\")\n\nclient = KadoaClient(KadoaClientConfig(api_key=\"your-api-key\"))\n\n# Listen to events with a lambda and log output\nclient.on_event(lambda e: logger.info(\"event: %s\", e.to_dict()))\n\n# Event types:\n# - entity:detected\n# - extraction:started\n# - extraction:status_changed\n# - extraction:data_available\n# - extraction:completed\n```\n\n## API Reference\n\n### KadoaClient(config: KadoaClientConfig)\n- `api_key` (required): Your Kadoa API key\n- `base_url` (optional): API base URL (default: 'https://api.kadoa.com')\n- `timeout` (optional): Request timeout in seconds (default: 30)\n\nReturns a client instance with:\n- `extraction`: Extraction module with `run()` method\n- `on_event()`: Subscribe to events\n- `off_event()`: Unsubscribe from events\n- `dispose()`: Releases resources and removes all event listeners\n\n### client.extraction.run(options: ExtractionOptions)\n- `urls`: List of URLs to extract from\n- `name`: Workflow name\n- Additional options available in API documentation\n\n## Examples\n\nSee [examples directory](https://github.com/kadoa-org/kadoa-sdks/tree/main/examples/python-examples) for more usage examples.\n\n## Requirements\n\n- Python 3.8+\n\n## License\n\nMIT\n\n## Support\n\n- Documentation: [docs.kadoa.com](https://docs.kadoa.com)\n- Support: [support@kadoa.com](mailto:support@kadoa.com)\n- Issues: [GitHub Issues](https://github.com/kadoa-org/kadoa-sdks/issues)\n- Changelog: [CHANGELOG.md](./CHANGELOG.md)\n",
"bugtrack_url": null,
"license": null,
"summary": "Official Kadoa SDK for Python - Web data extraction and automation",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://docs.kadoa.com",
"Homepage": "https://github.com/kadoa/kadoa-sdks",
"Repository": "https://github.com/kadoa/kadoa-sdks.git"
},
"split_keywords": [
"kadoa",
" api",
" sdk",
" client",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d0e252be76061bd8f65c84728548e2ef229a7dc6740b3527a137703af62ce29a",
"md5": "9af856754e8d6c6249dc2d3ac93b0886",
"sha256": "01c1af53123a460638955cccd52d8bb262f97f8c3483757ddc9b96b2ad464a91"
},
"downloads": -1,
"filename": "kadoa_sdk-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9af856754e8d6c6249dc2d3ac93b0886",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 659789,
"upload_time": "2025-09-08T07:19:32",
"upload_time_iso_8601": "2025-09-08T07:19:32.052694Z",
"url": "https://files.pythonhosted.org/packages/d0/e2/52be76061bd8f65c84728548e2ef229a7dc6740b3527a137703af62ce29a/kadoa_sdk-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fdaf3355064ea817007d22285130ddcbabfedda2c5558a1455a845eb6f5f7994",
"md5": "f41a3f2e522a38d1f29500554667a2e2",
"sha256": "f483ec92a006aacaeed8658653aac4a466d4bd182fc715b98dbae6b5752913e3"
},
"downloads": -1,
"filename": "kadoa_sdk-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "f41a3f2e522a38d1f29500554667a2e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 167144,
"upload_time": "2025-09-08T07:19:33",
"upload_time_iso_8601": "2025-09-08T07:19:33.559874Z",
"url": "https://files.pythonhosted.org/packages/fd/af/3355064ea817007d22285130ddcbabfedda2c5558a1455a845eb6f5f7994/kadoa_sdk-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-08 07:19:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kadoa",
"github_project": "kadoa-sdks",
"github_not_found": true,
"lcname": "kadoa-sdk"
}
