asteroid-odyssey 0.1.22__tar.gz → 0.4.0__tar.gz

asteroid_odyssey-0.4.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: asteroid-odyssey
+Version: 0.4.0
+Summary: A Python SDK for browser automation using Asteroid platform.
+Author-email: David Mlcoch <founders@asteroid.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/asteroid/asteroid-odyssey-py
+Project-URL: Homepage, https://asteroid.ai
+Project-URL: Documentation, https://docs.asteroid.ai
+Keywords: OpenAPI,OpenAPI-Generator,Asteroid Agents API,browser automation,AI agents
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Requires-Dist: requests>=2.28.0
+Requires-Dist: cryptography>=41.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.2.1; extra == "dev"
+Requires-Dist: pytest-cov>=2.8.1; extra == "dev"
+Requires-Dist: tox>=3.9.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: types-python-dateutil>=2.8.19.14; extra == "dev"
+Requires-Dist: mypy>=1.5; extra == "dev"
+
+# Asteroid Odyssey
+
+The official Python SDK for interacting with the Asteroid Agents API.
+
+## Installation
+
+```bash
+pip install asteroid-odyssey
+```
+
+## Usage
+
+Please head to our documentation at https://docs.asteroid.ai/sdk/python
+
+## License
+
+The Asteroid Odyssey SDK is available under the MIT License.
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+The SDK provides a high-level `AsteroidClient` class that makes it easy to interact with the Asteroid Agents API:
+
+```python
+from asteroid_odyssey import AsteroidClient
+
+# Create a client with your API key
+client = AsteroidClient('your-api-key')
+
+# Execute an agent
+execution_id = client.execute_agent('my-agent-id', {'input': 'some dynamic value'})
+
+# Wait for the execution to complete and get the result
+result = client.wait_for_execution_result(execution_id)
+print(result)
+
+# Or check status manually
+status = client.get_execution_status(execution_id)
+print(f"Status: {status.status}")
+
+# Upload files to an execution
+hello_content = "Hello World!".encode()
+response = client.upload_execution_files(execution_id, [hello_content])
+print(f"Uploaded files: {response.file_ids}")
+
+# Get browser session recording (for completed executions)
+recording_url = client.get_browser_session_recording(execution_id)
+print(f"Recording available at: {recording_url}")
+```
+
+### Context Manager Usage
+
+The client can also be used as a context manager:
+
+```python
+from asteroid_odyssey import AsteroidClient
+
+with AsteroidClient('your-api-key') as client:
+    execution_id = client.execute_agent('my-agent-id', {'input': 'test'})
+    result = client.wait_for_execution_result(execution_id)
+    print(result)
+```
+
+### Convenience Functions
+
+The SDK also provides convenience functions:
+
+```python
+from asteroid_odyssey import create_client, execute_agent, wait_for_execution_result
+
+client = create_client('your-api-key')
+execution_id = execute_agent(client, 'my-agent-id', {'input': 'test'})
+result = wait_for_execution_result(client, execution_id)
+```
+
+## API Reference
+
+### AsteroidClient
+
+The main client class provides the following methods:
+
+- `execute_agent(agent_id, agent_profile_id (optional), execution_data(optional))` - Execute an agent and return execution ID
+- `get_execution_status(execution_id)` - Get current execution status
+- `get_execution_result(execution_id)` - Get final execution result
+- `wait_for_execution_result(execution_id, interval=1.0, timeout=3600.0)` - Wait for completion
+- `upload_execution_files(execution_id, files, default_filename="file.txt")` - Upload files
+- `get_browser_session_recording(execution_id)` - Get browser recording URL
+
+### Low-Level API Access
+
+If you need direct access to the generated OpenAPI client, you can still use it:
+
+```python
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://odyssey.asteroid.ai/api/v1
+configuration = openapi_client.Configuration(
+    host = "https://odyssey.asteroid.ai/api/v1"
+)
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.APIApi(api_client)
+
+    try:
+        # Get the OpenAPI schema
+        api_instance.get_open_api()
+    except ApiException as e:
+        print("Exception when calling APIApi->get_open_api: %s\n" % e)
+```
+
+| Class            | Method                          | Return Type Representation | Description                                              |
+| ---------------- | ------------------------------- | -------------------------- | -------------------------------------------------------- |
+| `AsteroidClient` | `execute_agent`                 | `str` (execution ID)       | Executes an agent and returns its execution ID.          |
+| `AsteroidClient` | `get_execution_status`          | `dict-like object`         | Gets the current status of an execution.                 |
+| `AsteroidClient` | `get_execution_result`          | `dict` (execution result)  | Retrieves the result data of a completed execution.      |
+| `AsteroidClient` | `get_browser_session_recording` | `str` (URL)                | Returns the session recording URL of an execution.       |
+| `AsteroidClient` | `upload_execution_files`        | `dict-like object`         | Uploads files to an execution and returns file metadata. |
+
+
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+To generate an API key, go to our [platform](https://platform.asteroid.ai) and in your profile section, click on API Keys. You can now create and manage your API keys.
+
+Authentication schemes defined for the API:
+<a id="ApiKeyAuth"></a>
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-Asteroid-Agents-Api-Key
+- **Location**: HTTP header
+
+
+## Development quick‑start
+```bash 
+# clone
+git clone https://github.com/<org>/asteroid-odyssey-py.git
+cd asteroid-odyssey-py
+
+# create / activate a virtualenv (example using venv)
+python -m venv .venv
+source .venv/bin/activate
+
+# install project in *editable* mode + dev tools
+pip install -U pip
+pip install -e .[dev]     # or: pip install -e .
+
+# run the generated SDK tests
+pytest
+```
+
+## Regenerating the SDK
+
+To update the SDK, regenerate the code by running
+
+```bash
+ ./regen-sdk.sh
+ ```
+
+ If the OpenAPI spec changes:
+ ```bash 
+./regen-sdk.sh       # regenerate client & docs
+pip install -e .     # refresh editable install (safe to rerun)
+pytest               # all tests should still pass
+```
+
+After generation, ensure `pyproject.toml` is configured correctly and that files are modified correctly. Check for new files and if they are needed.
+
+
+
+
+

asteroid_odyssey-0.4.0/README.md

@@ -0,0 +1,181 @@
+# Asteroid Odyssey
+
+The official Python SDK for interacting with the Asteroid Agents API.
+
+## Installation
+
+```bash
+pip install asteroid-odyssey
+```
+
+## Usage
+
+Please head to our documentation at https://docs.asteroid.ai/sdk/python
+
+## License
+
+The Asteroid Odyssey SDK is available under the MIT License.
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+The SDK provides a high-level `AsteroidClient` class that makes it easy to interact with the Asteroid Agents API:
+
+```python
+from asteroid_odyssey import AsteroidClient
+
+# Create a client with your API key
+client = AsteroidClient('your-api-key')
+
+# Execute an agent
+execution_id = client.execute_agent('my-agent-id', {'input': 'some dynamic value'})
+
+# Wait for the execution to complete and get the result
+result = client.wait_for_execution_result(execution_id)
+print(result)
+
+# Or check status manually
+status = client.get_execution_status(execution_id)
+print(f"Status: {status.status}")
+
+# Upload files to an execution
+hello_content = "Hello World!".encode()
+response = client.upload_execution_files(execution_id, [hello_content])
+print(f"Uploaded files: {response.file_ids}")
+
+# Get browser session recording (for completed executions)
+recording_url = client.get_browser_session_recording(execution_id)
+print(f"Recording available at: {recording_url}")
+```
+
+### Context Manager Usage
+
+The client can also be used as a context manager:
+
+```python
+from asteroid_odyssey import AsteroidClient
+
+with AsteroidClient('your-api-key') as client:
+    execution_id = client.execute_agent('my-agent-id', {'input': 'test'})
+    result = client.wait_for_execution_result(execution_id)
+    print(result)
+```
+
+### Convenience Functions
+
+The SDK also provides convenience functions:
+
+```python
+from asteroid_odyssey import create_client, execute_agent, wait_for_execution_result
+
+client = create_client('your-api-key')
+execution_id = execute_agent(client, 'my-agent-id', {'input': 'test'})
+result = wait_for_execution_result(client, execution_id)
+```
+
+## API Reference
+
+### AsteroidClient
+
+The main client class provides the following methods:
+
+- `execute_agent(agent_id, agent_profile_id (optional), execution_data(optional))` - Execute an agent and return execution ID
+- `get_execution_status(execution_id)` - Get current execution status
+- `get_execution_result(execution_id)` - Get final execution result
+- `wait_for_execution_result(execution_id, interval=1.0, timeout=3600.0)` - Wait for completion
+- `upload_execution_files(execution_id, files, default_filename="file.txt")` - Upload files
+- `get_browser_session_recording(execution_id)` - Get browser recording URL
+
+### Low-Level API Access
+
+If you need direct access to the generated OpenAPI client, you can still use it:
+
+```python
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://odyssey.asteroid.ai/api/v1
+configuration = openapi_client.Configuration(
+    host = "https://odyssey.asteroid.ai/api/v1"
+)
+
+# Enter a context with an instance of the API client
+with openapi_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = openapi_client.APIApi(api_client)
+
+    try:
+        # Get the OpenAPI schema
+        api_instance.get_open_api()
+    except ApiException as e:
+        print("Exception when calling APIApi->get_open_api: %s\n" % e)
+```
+
+| Class            | Method                          | Return Type Representation | Description                                              |
+| ---------------- | ------------------------------- | -------------------------- | -------------------------------------------------------- |
+| `AsteroidClient` | `execute_agent`                 | `str` (execution ID)       | Executes an agent and returns its execution ID.          |
+| `AsteroidClient` | `get_execution_status`          | `dict-like object`         | Gets the current status of an execution.                 |
+| `AsteroidClient` | `get_execution_result`          | `dict` (execution result)  | Retrieves the result data of a completed execution.      |
+| `AsteroidClient` | `get_browser_session_recording` | `str` (URL)                | Returns the session recording URL of an execution.       |
+| `AsteroidClient` | `upload_execution_files`        | `dict-like object`         | Uploads files to an execution and returns file metadata. |
+
+
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+To generate an API key, go to our [platform](https://platform.asteroid.ai) and in your profile section, click on API Keys. You can now create and manage your API keys.
+
+Authentication schemes defined for the API:
+<a id="ApiKeyAuth"></a>
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-Asteroid-Agents-Api-Key
+- **Location**: HTTP header
+
+
+## Development quick‑start
+```bash 
+# clone
+git clone https://github.com/<org>/asteroid-odyssey-py.git
+cd asteroid-odyssey-py
+
+# create / activate a virtualenv (example using venv)
+python -m venv .venv
+source .venv/bin/activate
+
+# install project in *editable* mode + dev tools
+pip install -U pip
+pip install -e .[dev]     # or: pip install -e .
+
+# run the generated SDK tests
+pytest
+```
+
+## Regenerating the SDK
+
+To update the SDK, regenerate the code by running
+
+```bash
+ ./regen-sdk.sh
+ ```
+
+ If the OpenAPI spec changes:
+ ```bash 
+./regen-sdk.sh       # regenerate client & docs
+pip install -e .     # refresh editable install (safe to rerun)
+pytest               # all tests should still pass
+```
+
+After generation, ensure `pyproject.toml` is configured correctly and that files are modified correctly. Check for new files and if they are needed.
+
+
+
+
+

asteroid_odyssey-0.4.0/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "asteroid-odyssey"
+version = "0.4.0"
+authors = [
+  { name = "David Mlcoch", email = "founders@asteroid.com" },
+]
+description = "A Python SDK for browser automation using Asteroid platform."
+readme = "README.md"
+requires-python = ">=3.9"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Asteroid Agents API", "browser automation", "AI agents"]
+license = "MIT"
+
+dependencies = [
+  "urllib3>=2.1.0,<3.0.0",
+  "python-dateutil>=2.8.2",
+  "pydantic>=2",
+  "typing-extensions>=4.7.1",
+  "requests>=2.28.0",
+  "cryptography>=41.0.0"
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP :: Browsers",
+]
+
+[project.urls]
+Repository = "https://github.com/asteroid/asteroid-odyssey-py"
+Homepage = "https://asteroid.ai"
+Documentation = "https://docs.asteroid.ai"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.2.1",
+  "pytest-cov>=2.8.1",
+  "tox>=3.9.0",
+  "flake8>=4.0.0",
+  "types-python-dateutil>=2.8.19.14",
+  "mypy>=1.5",
+]
+
+[build-system]
+requires = ["setuptools>=65", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where   = ["src"]
+include = ["asteroid_odyssey", "asteroid_odyssey.*"]
+exclude = ["tests", "tests.*"]
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = ["src/asteroid_odyssey", "tests"]
+strict = false
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true

asteroid_odyssey-0.4.0/src/asteroid_odyssey/__init__.py

@@ -0,0 +1,29 @@
+from .client import (
+    AsteroidClient,
+    create_client,
+    execute_agent,
+    get_execution_status,
+    get_execution_result,
+    wait_for_execution_result,
+    upload_execution_files,
+    get_browser_session_recording,
+    AsteroidAPIError,
+    ExecutionError,
+    TimeoutError
+)
+from .agents_v1_gen import ExecutionResult
+
+__all__ = [
+    'AsteroidClient',
+    'create_client',
+    'execute_agent',
+    'get_execution_status',
+    'get_execution_result',
+    'wait_for_execution_result',
+    'upload_execution_files',
+    'get_browser_session_recording',
+    'AsteroidAPIError',
+    'ExecutionError',
+    'TimeoutError',
+    'ExecutionResult'
+]

asteroid_odyssey-0.4.0/src/asteroid_odyssey/agents_v1_gen/__init__.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Asteroid Agents API
+
+    Version 1 of the Asteroid Agents API
+
+    The version of the OpenAPI document: v1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "APIApi",
+    "AgentProfileApi",
+    "ExecutionApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AgentProfile",
+    "BrowserSessionRecordingResponse",
+    "CountryCode",
+    "CreateAgentProfileRequest",
+    "Credential",
+    "DeleteAgentProfile200Response",
+    "ErrorResponse",
+    "ExecutionResponse",
+    "ExecutionResult",
+    "ExecutionResultResponse",
+    "ExecutionStatusResponse",
+    "HealthCheck200Response",
+    "HealthCheck500Response",
+    "ProxyType",
+    "Status",
+    "StructuredAgentExecutionRequest",
+    "UpdateAgentProfileRequest",
+    "UploadExecutionFiles200Response",
+]
+
+# import apis into sdk package
+from asteroid_odyssey.agents_v1_gen.api.api_api import APIApi as APIApi
+from asteroid_odyssey.agents_v1_gen.api.agent_profile_api import AgentProfileApi as AgentProfileApi
+from asteroid_odyssey.agents_v1_gen.api.execution_api import ExecutionApi as ExecutionApi
+
+# import ApiClient
+from asteroid_odyssey.agents_v1_gen.api_response import ApiResponse as ApiResponse
+from asteroid_odyssey.agents_v1_gen.api_client import ApiClient as ApiClient
+from asteroid_odyssey.agents_v1_gen.configuration import Configuration as Configuration
+from asteroid_odyssey.agents_v1_gen.exceptions import OpenApiException as OpenApiException
+from asteroid_odyssey.agents_v1_gen.exceptions import ApiTypeError as ApiTypeError
+from asteroid_odyssey.agents_v1_gen.exceptions import ApiValueError as ApiValueError
+from asteroid_odyssey.agents_v1_gen.exceptions import ApiKeyError as ApiKeyError
+from asteroid_odyssey.agents_v1_gen.exceptions import ApiAttributeError as ApiAttributeError
+from asteroid_odyssey.agents_v1_gen.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from asteroid_odyssey.agents_v1_gen.models.agent_profile import AgentProfile as AgentProfile
+from asteroid_odyssey.agents_v1_gen.models.browser_session_recording_response import BrowserSessionRecordingResponse as BrowserSessionRecordingResponse
+from asteroid_odyssey.agents_v1_gen.models.country_code import CountryCode as CountryCode
+from asteroid_odyssey.agents_v1_gen.models.create_agent_profile_request import CreateAgentProfileRequest as CreateAgentProfileRequest
+from asteroid_odyssey.agents_v1_gen.models.credential import Credential as Credential
+from asteroid_odyssey.agents_v1_gen.models.delete_agent_profile200_response import DeleteAgentProfile200Response as DeleteAgentProfile200Response
+from asteroid_odyssey.agents_v1_gen.models.error_response import ErrorResponse as ErrorResponse
+from asteroid_odyssey.agents_v1_gen.models.execution_response import ExecutionResponse as ExecutionResponse
+from asteroid_odyssey.agents_v1_gen.models.execution_result import ExecutionResult as ExecutionResult
+from asteroid_odyssey.agents_v1_gen.models.execution_result_response import ExecutionResultResponse as ExecutionResultResponse
+from asteroid_odyssey.agents_v1_gen.models.execution_status_response import ExecutionStatusResponse as ExecutionStatusResponse
+from asteroid_odyssey.agents_v1_gen.models.health_check200_response import HealthCheck200Response as HealthCheck200Response
+from asteroid_odyssey.agents_v1_gen.models.health_check500_response import HealthCheck500Response as HealthCheck500Response
+from asteroid_odyssey.agents_v1_gen.models.proxy_type import ProxyType as ProxyType
+from asteroid_odyssey.agents_v1_gen.models.status import Status as Status
+from asteroid_odyssey.agents_v1_gen.models.structured_agent_execution_request import StructuredAgentExecutionRequest as StructuredAgentExecutionRequest
+from asteroid_odyssey.agents_v1_gen.models.update_agent_profile_request import UpdateAgentProfileRequest as UpdateAgentProfileRequest
+from asteroid_odyssey.agents_v1_gen.models.upload_execution_files200_response import UploadExecutionFiles200Response as UploadExecutionFiles200Response

asteroid_odyssey-0.4.0/src/asteroid_odyssey/agents_v1_gen/api/__init__.py

@@ -0,0 +1,7 @@
+# flake8: noqa
+
+# import apis into api package
+from asteroid_odyssey.agents_v1_gen.api.api_api import APIApi
+from asteroid_odyssey.agents_v1_gen.api.agent_profile_api import AgentProfileApi
+from asteroid_odyssey.agents_v1_gen.api.execution_api import ExecutionApi
+