simplex 1.2.80__tar.gz → 2.0.0__tar.gz

{simplex-1.2.80 → simplex-2.0.0}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Simplex Labs, Inc.
+Copyright (c) 2024 Simplex
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE. 
+SOFTWARE.

simplex-2.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include requirements.txt
+recursive-include simplex *.py
+recursive-exclude tests *
+recursive-exclude examples *

simplex-2.0.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: simplex
+Version: 2.0.0
+Summary: Official Python SDK for the Simplex API
+Author-email: Simplex <support@simplex.sh>
+License: MIT
+Project-URL: Homepage, https://simplex.sh
+Project-URL: Documentation, https://docs.simplex.sh
+Project-URL: Repository, https://github.com/simplexlabs/simplex-python
+Keywords: simplex,api,sdk,workflow,automation,browser,scraping
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: types-requests>=2.25.0; extra == "dev"
+Dynamic: license-file
+
+# Simplex Python SDK
+
+Official Python SDK for the [Simplex API](https://simplex.sh) - A powerful workflow automation platform for browser-based tasks.
+
+[![Python Version](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+```bash
+pip install simplex
+```
+
+## Quick Start
+
+```python
+import time
+from simplex import SimplexClient
+
+# Initialize the client
+client = SimplexClient(api_key="your-api-key")
+
+# Run a workflow
+response = client.run_workflow(
+    "workflow-id",
+    variables={"email": "user@example.com"}
+)
+
+print(f"Session started: {response['session_id']}")
+
+# Poll for completion
+while True:
+    status = client.get_session_status(response["session_id"])
+    if not status["in_progress"]:
+        break
+    time.sleep(1)
+
+# Check results
+if status["success"]:
+    print("Success!")
+    print("Scraper outputs:", status["scraper_outputs"])
+    print("File metadata:", status["file_metadata"])
+else:
+    print("Failed")
+```
+
+## API Reference
+
+### SimplexClient
+
+```python
+client = SimplexClient(
+    api_key="your-api-key",
+    base_url="https://api.simplex.sh",  # Optional
+    timeout=30,                          # Request timeout in seconds
+    max_retries=3,                       # Retry attempts for failed requests
+    retry_delay=1.0,                     # Delay between retries in seconds
+)
+```
+
+### Methods
+
+#### `run_workflow(workflow_id, variables=None, metadata=None, webhook_url=None)`
+
+Run a workflow by its ID.
+
+```python
+response = client.run_workflow(
+    "workflow-id",
+    variables={"key": "value"},
+    metadata="optional metadata",
+    webhook_url="https://your-webhook.com/callback"
+)
+
+print(response["session_id"])  # Session ID for polling
+print(response["vnc_url"])     # VNC URL to watch the session
+```
+
+#### `get_session_status(session_id)`
+
+Get the status of a running or completed session.
+
+```python
+status = client.get_session_status("session-id")
+
+print(status["in_progress"])       # True while running
+print(status["success"])           # True/False when complete, None while running
+print(status["scraper_outputs"])   # Data collected by scrapers
+print(status["file_metadata"])     # Metadata for downloaded files
+print(status["metadata"])          # Custom metadata
+print(status["workflow_metadata"]) # Workflow metadata
+```
+
+#### `download_session_files(session_id, filename=None)`
+
+Download files from a completed session.
+
+```python
+# Download all files as a zip
+zip_data = client.download_session_files("session-id")
+with open("files.zip", "wb") as f:
+    f.write(zip_data)
+
+# Download a specific file
+pdf_data = client.download_session_files("session-id", filename="report.pdf")
+with open("report.pdf", "wb") as f:
+    f.write(pdf_data)
+```
+
+#### `retrieve_session_replay(session_id)`
+
+Download the session replay video (MP4).
+
+```python
+video = client.retrieve_session_replay("session-id")
+with open("replay.mp4", "wb") as f:
+    f.write(video)
+```
+
+#### `retrieve_session_logs(session_id)`
+
+Get the session logs as parsed JSON.
+
+```python
+logs = client.retrieve_session_logs("session-id")
+for entry in logs:
+    print(f"{entry['timestamp']}: {entry['message']}")
+```
+
+## Error Handling
+
+The SDK provides specific exception types for different error scenarios:
+
+```python
+from simplex import (
+    SimplexClient,
+    SimplexError,
+    WorkflowError,
+    AuthenticationError,
+    RateLimitError,
+    NetworkError,
+    ValidationError,
+)
+
+client = SimplexClient(api_key="your-api-key")
+
+try:
+    result = client.run_workflow("workflow-id")
+except AuthenticationError as e:
+    print(f"Invalid API key: {e.message}")
+except RateLimitError as e:
+    print(f"Rate limited. Retry after {e.retry_after} seconds")
+except ValidationError as e:
+    print(f"Invalid request: {e.message}")
+except WorkflowError as e:
+    print(f"Workflow error: {e.message}")
+    print(f"Session ID: {e.session_id}")
+except NetworkError as e:
+    print(f"Network error: {e.message}")
+except SimplexError as e:
+    print(f"General error: {e.message}")
+```
+
+## Type Hints
+
+The SDK includes full type hints for better IDE support:
+
+```python
+from simplex import (
+    SimplexClient,
+    SessionStatusResponse,
+    RunWorkflowResponse,
+    FileMetadata,
+)
+
+client = SimplexClient(api_key="your-api-key")
+response: RunWorkflowResponse = client.run_workflow("workflow-id")
+status: SessionStatusResponse = client.get_session_status(response["session_id"])
+```
+
+## Requirements
+
+- Python 3.9+
+- `requests>=2.25.0`
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Support
+
+- Documentation: [https://docs.simplex.sh](https://docs.simplex.sh)
+- Email: support@simplex.sh

simplex-2.0.0/README.md

@@ -0,0 +1,193 @@
+# Simplex Python SDK
+
+Official Python SDK for the [Simplex API](https://simplex.sh) - A powerful workflow automation platform for browser-based tasks.
+
+[![Python Version](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+```bash
+pip install simplex
+```
+
+## Quick Start
+
+```python
+import time
+from simplex import SimplexClient
+
+# Initialize the client
+client = SimplexClient(api_key="your-api-key")
+
+# Run a workflow
+response = client.run_workflow(
+    "workflow-id",
+    variables={"email": "user@example.com"}
+)
+
+print(f"Session started: {response['session_id']}")
+
+# Poll for completion
+while True:
+    status = client.get_session_status(response["session_id"])
+    if not status["in_progress"]:
+        break
+    time.sleep(1)
+
+# Check results
+if status["success"]:
+    print("Success!")
+    print("Scraper outputs:", status["scraper_outputs"])
+    print("File metadata:", status["file_metadata"])
+else:
+    print("Failed")
+```
+
+## API Reference
+
+### SimplexClient
+
+```python
+client = SimplexClient(
+    api_key="your-api-key",
+    base_url="https://api.simplex.sh",  # Optional
+    timeout=30,                          # Request timeout in seconds
+    max_retries=3,                       # Retry attempts for failed requests
+    retry_delay=1.0,                     # Delay between retries in seconds
+)
+```
+
+### Methods
+
+#### `run_workflow(workflow_id, variables=None, metadata=None, webhook_url=None)`
+
+Run a workflow by its ID.
+
+```python
+response = client.run_workflow(
+    "workflow-id",
+    variables={"key": "value"},
+    metadata="optional metadata",
+    webhook_url="https://your-webhook.com/callback"
+)
+
+print(response["session_id"])  # Session ID for polling
+print(response["vnc_url"])     # VNC URL to watch the session
+```
+
+#### `get_session_status(session_id)`
+
+Get the status of a running or completed session.
+
+```python
+status = client.get_session_status("session-id")
+
+print(status["in_progress"])       # True while running
+print(status["success"])           # True/False when complete, None while running
+print(status["scraper_outputs"])   # Data collected by scrapers
+print(status["file_metadata"])     # Metadata for downloaded files
+print(status["metadata"])          # Custom metadata
+print(status["workflow_metadata"]) # Workflow metadata
+```
+
+#### `download_session_files(session_id, filename=None)`
+
+Download files from a completed session.
+
+```python
+# Download all files as a zip
+zip_data = client.download_session_files("session-id")
+with open("files.zip", "wb") as f:
+    f.write(zip_data)
+
+# Download a specific file
+pdf_data = client.download_session_files("session-id", filename="report.pdf")
+with open("report.pdf", "wb") as f:
+    f.write(pdf_data)
+```
+
+#### `retrieve_session_replay(session_id)`
+
+Download the session replay video (MP4).
+
+```python
+video = client.retrieve_session_replay("session-id")
+with open("replay.mp4", "wb") as f:
+    f.write(video)
+```
+
+#### `retrieve_session_logs(session_id)`
+
+Get the session logs as parsed JSON.
+
+```python
+logs = client.retrieve_session_logs("session-id")
+for entry in logs:
+    print(f"{entry['timestamp']}: {entry['message']}")
+```
+
+## Error Handling
+
+The SDK provides specific exception types for different error scenarios:
+
+```python
+from simplex import (
+    SimplexClient,
+    SimplexError,
+    WorkflowError,
+    AuthenticationError,
+    RateLimitError,
+    NetworkError,
+    ValidationError,
+)
+
+client = SimplexClient(api_key="your-api-key")
+
+try:
+    result = client.run_workflow("workflow-id")
+except AuthenticationError as e:
+    print(f"Invalid API key: {e.message}")
+except RateLimitError as e:
+    print(f"Rate limited. Retry after {e.retry_after} seconds")
+except ValidationError as e:
+    print(f"Invalid request: {e.message}")
+except WorkflowError as e:
+    print(f"Workflow error: {e.message}")
+    print(f"Session ID: {e.session_id}")
+except NetworkError as e:
+    print(f"Network error: {e.message}")
+except SimplexError as e:
+    print(f"General error: {e.message}")
+```
+
+## Type Hints
+
+The SDK includes full type hints for better IDE support:
+
+```python
+from simplex import (
+    SimplexClient,
+    SessionStatusResponse,
+    RunWorkflowResponse,
+    FileMetadata,
+)
+
+client = SimplexClient(api_key="your-api-key")
+response: RunWorkflowResponse = client.run_workflow("workflow-id")
+status: SessionStatusResponse = client.get_session_status(response["session_id"])
+```
+
+## Requirements
+
+- Python 3.9+
+- `requests>=2.25.0`
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Support
+
+- Documentation: [https://docs.simplex.sh](https://docs.simplex.sh)
+- Email: support@simplex.sh

simplex-2.0.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "simplex"
+version = "2.0.0"
+description = "Official Python SDK for the Simplex API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "Simplex", email = "support@simplex.sh"}
+]
+keywords = ["simplex", "api", "sdk", "workflow", "automation", "browser", "scraping"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests>=2.25.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "mypy>=1.0.0",
+    "types-requests>=2.25.0",
+]
+
+[project.urls]
+Homepage = "https://simplex.sh"
+Documentation = "https://docs.simplex.sh"
+Repository = "https://github.com/simplexlabs/simplex-python"
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

simplex-2.0.0/requirements.txt

@@ -0,0 +1,6 @@
+# Core dependencies
+requests>=2.25.0
+urllib3>=1.26.0
+
+# Development dependencies (optional)
+# Install with: pip install -r requirements-dev.txt

simplex-2.0.0/simplex/__init__.py

@@ -0,0 +1,50 @@
+"""
+Simplex Python SDK
+
+Official Python SDK for the Simplex API - A workflow automation platform.
+
+Example usage:
+    >>> from simplex import SimplexClient
+    >>> client = SimplexClient(api_key="your-api-key")
+    >>> result = client.run_workflow("workflow-id", variables={"key": "value"})
+    >>>
+    >>> # Poll for completion
+    >>> import time
+    >>> while True:
+    ...     status = client.get_session_status(result["session_id"])
+    ...     if not status["in_progress"]:
+    ...         break
+    ...     time.sleep(1)
+    >>>
+    >>> if status["success"]:
+    ...     print("Outputs:", status["scraper_outputs"])
+"""
+
+from simplex.client import SimplexClient
+from simplex.errors import (
+    AuthenticationError,
+    NetworkError,
+    RateLimitError,
+    SimplexError,
+    ValidationError,
+    WorkflowError,
+)
+from simplex.types import (
+    FileMetadata,
+    RunWorkflowResponse,
+    SessionStatusResponse,
+)
+
+__version__ = "2.0.0"
+__all__ = [
+    "SimplexClient",
+    "SimplexError",
+    "NetworkError",
+    "ValidationError",
+    "AuthenticationError",
+    "RateLimitError",
+    "WorkflowError",
+    "FileMetadata",
+    "SessionStatusResponse",
+    "RunWorkflowResponse",
+]