optexity 0.1.2__tar.gz → 0.1.4__tar.gz

{optexity-0.1.2 → optexity-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optexity
-Version: 0.1.2
+Version: 0.1.4
 Summary: Optexity is a platform for building and running browser and computer agents.
 Author-email: Optexity <support@optexity.com>
 Requires-Python: >=3.11
@@ -50,30 +50,19 @@ Once logged in, navigate to the **API Keys** section in your dashboard and creat
 
 Install the **Optexity Recorder** extension from the [Chrome Web Store](https://chromewebstore.google.com/detail/optexity-recorder/pbaganbicadeoacahamnbgohafchgakp). This extension captures your browser interactions and converts them into automation workflows.
 
-## Installation
-
 ### Prerequisites
 
 - Python 3.11+
-- Node.js 18+ (included with Conda option)
 - Git
 
-### Step 1: Clone the Repository
-
-```bash
-git clone git@github.com:Optexity/optexity.git
-cd optexity
-./update_submodule.sh
-```
-
-### Step 2: Create and Activate a Python Environment
+## Create and Activate a Python Environment (Optional)
 
 Choose **one** of the options below.
 
 #### Option A – Conda (includes Python 3.11 and Node.js)
 
 ```bash
-conda create -n optexity python=3.11 nodejs
+conda create -n optexity python=3.11
 conda activate optexity
 ```
 
@@ -86,32 +75,29 @@ python3 -m venv .venv
 source .venv/bin/activate
 ```
 
-> If you pick `venv`, ensure Node.js 18+ is already available on your machine before continuing.
+## Installation
 
-### Step 3: Install Dependencies
+### Quick Installation (from PyPI)
 
-Run everything from the repository root:
+Install Optexity directly from PyPI:
 
 ```bash
-pip install -e "external/browser-use"
-pip install -e .
-playwright install --with-deps chromium chrome
-patchright install chromium chrome
-pre-commit install --install-hooks
-pre-commit install --hook-type pre-push
+pip install optexity
 ```
+**OR**
 
-### Step 4: Configure Your Environment
+### Installation from Source
 
-Optexity reads configuration from a standard `.env` file via the `ENV_PATH` environment variable.
+If you want to clone and edit from source:
 
-Create a `.env` file in the repo root:
 
 ```bash
-touch .env
+git clone git@github.com:Optexity/optexity.git
+cd optexity
+pip install -e .
 ```
 
-Add the required values:
+## Set required environment variables:
 
 ```bash
 API_KEY=YOUR_OPTEXITY_API_KEY           # API key used for authenticated requests
@@ -121,14 +107,14 @@ DEPLOYMENT=dev                          # or "prod" in production
 
 You can get your free Google Gemini API key from the [Google AI Studio Console](https://aistudio.google.com).
 
-Then export `ENV_PATH` when running processes that rely on these settings:
+## Install required browsers:
+
+Install playwright and patchright browsers:
 
 ```bash
-export ENV_PATH=.env
+optexity install-browsers
 ```
 
-> If `ENV_PATH` is not set, the inference server will try to start with defaults and log a warning. For normal usage you should always point `ENV_PATH` at a real `.env` file.
-
 ## Recording Your First Automation
 
 The fastest way to create an automation is by recording your actions directly in the browser.
@@ -156,12 +142,10 @@ The fastest way to create an automation is by recording your actions directly in
 
 ### Start the Inference Server
 
-The primary way to run browser automations locally is via the inference child process server.
-
-From the repository root:
+The primary way to run browser automations locally is via the inference server.
 
 ```bash
-ENV_PATH=.env python optexity/inference/child_process.py --port 9000 --child_process_id 0
+optexity inference --port 9000 --child_process_id 0
 ```
 
 Key parameters:

{optexity-0.1.2 → optexity-0.1.4}/README.md

@@ -25,30 +25,19 @@ Once logged in, navigate to the **API Keys** section in your dashboard and creat
 
 Install the **Optexity Recorder** extension from the [Chrome Web Store](https://chromewebstore.google.com/detail/optexity-recorder/pbaganbicadeoacahamnbgohafchgakp). This extension captures your browser interactions and converts them into automation workflows.
 
-## Installation
-
 ### Prerequisites
 
 - Python 3.11+
-- Node.js 18+ (included with Conda option)
 - Git
 
-### Step 1: Clone the Repository
-
-```bash
-git clone git@github.com:Optexity/optexity.git
-cd optexity
-./update_submodule.sh
-```
-
-### Step 2: Create and Activate a Python Environment
+## Create and Activate a Python Environment (Optional)
 
 Choose **one** of the options below.
 
 #### Option A – Conda (includes Python 3.11 and Node.js)
 
 ```bash
-conda create -n optexity python=3.11 nodejs
+conda create -n optexity python=3.11
 conda activate optexity
 ```
 
@@ -61,32 +50,29 @@ python3 -m venv .venv
 source .venv/bin/activate
 ```
 
-> If you pick `venv`, ensure Node.js 18+ is already available on your machine before continuing.
+## Installation
 
-### Step 3: Install Dependencies
+### Quick Installation (from PyPI)
 
-Run everything from the repository root:
+Install Optexity directly from PyPI:
 
 ```bash
-pip install -e "external/browser-use"
-pip install -e .
-playwright install --with-deps chromium chrome
-patchright install chromium chrome
-pre-commit install --install-hooks
-pre-commit install --hook-type pre-push
+pip install optexity
 ```
+**OR**
 
-### Step 4: Configure Your Environment
+### Installation from Source
 
-Optexity reads configuration from a standard `.env` file via the `ENV_PATH` environment variable.
+If you want to clone and edit from source:
 
-Create a `.env` file in the repo root:
 
 ```bash
-touch .env
+git clone git@github.com:Optexity/optexity.git
+cd optexity
+pip install -e .
 ```
 
-Add the required values:
+## Set required environment variables:
 
 ```bash
 API_KEY=YOUR_OPTEXITY_API_KEY           # API key used for authenticated requests
@@ -96,14 +82,14 @@ DEPLOYMENT=dev                          # or "prod" in production
 
 You can get your free Google Gemini API key from the [Google AI Studio Console](https://aistudio.google.com).
 
-Then export `ENV_PATH` when running processes that rely on these settings:
+## Install required browsers:
+
+Install playwright and patchright browsers:
 
 ```bash
-export ENV_PATH=.env
+optexity install-browsers
 ```
 
-> If `ENV_PATH` is not set, the inference server will try to start with defaults and log a warning. For normal usage you should always point `ENV_PATH` at a real `.env` file.
-
 ## Recording Your First Automation
 
 The fastest way to create an automation is by recording your actions directly in the browser.
@@ -131,12 +117,10 @@ The fastest way to create an automation is by recording your actions directly in
 
 ### Start the Inference Server
 
-The primary way to run browser automations locally is via the inference child process server.
-
-From the repository root:
+The primary way to run browser automations locally is via the inference server.
 
 ```bash
-ENV_PATH=.env python optexity/inference/child_process.py --port 9000 --child_process_id 0
+optexity inference --port 9000 --child_process_id 0
 ```
 
 Key parameters:

{optexity-0.1.2 → optexity-0.1.4}/optexity/cli.py

@@ -64,7 +64,7 @@ def main() -> None:
         "inference", help="Run Optexity inference server"
     )
     inference_cmd.add_argument("--host", default="0.0.0.0")
-    inference_cmd.add_argument("--port", type=int, required=True)
+    inference_cmd.add_argument("--port", type=int, default=9000)
     inference_cmd.add_argument(
         "--child_process_id", "--child-process-id", type=int, default=0
     )

optexity-0.1.4/optexity/examples/add_example.py

@@ -0,0 +1,88 @@
+import argparse
+import logging
+from urllib.parse import urljoin
+
+import httpx
+
+from optexity.examples import (
+    download_pdf_url,
+    file_upload,
+    i94,
+    i94_travel_history,
+    peachstate_medicaid,
+    supabase_login,
+)
+from optexity.utils.settings import Settings
+
+logger = logging.getLogger(__name__)
+settings = Settings()
+
+logger.setLevel(logging.INFO)
+
+
+def main(args):
+    if args.example == "i94":
+        example = i94
+    elif args.example == "i94_travel_history":
+        example = i94_travel_history
+    elif args.example == "peachstate_medicaid":
+        example = peachstate_medicaid
+    elif args.example == "supabase_login":
+        example = supabase_login
+    elif args.example == "download_pdf_url":
+        example = download_pdf_url
+    elif args.example == "file_upload":
+        example = file_upload
+    else:
+        raise ValueError(f"Invalid example: {args.example}")
+    try:
+        logger.info(f"➕ Adding example: {args.example}")
+        headers = {"x-api-key": settings.API_KEY}
+        with httpx.Client() as client:
+            response = client.post(
+                urljoin(
+                    settings.SERVER_URL,
+                    (
+                        settings.ADD_EXAMPLE_ENDPOINT
+                        if not args.update
+                        else settings.UPDATE_EXAMPLE_ENDPOINT
+                    ),
+                ),
+                headers=headers,
+                json={
+                    "automation": example.automation.model_dump(
+                        exclude_none=True, exclude_defaults=True
+                    ),
+                    "description": example.description,
+                    "endpoint_name": example.endpoint_name,
+                },
+            )
+            response.raise_for_status()
+            logger.info(f"✓ Example added successfully: {response.json()}")
+    except Exception as e:
+        logger.error(f"❌ Error adding example: {response.json()}")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--example",
+        type=str,
+        choices=[
+            "i94",
+            "i94_travel_history",
+            "peachstate_medicaid",
+            "supabase_login",
+            "download_pdf_url",
+            "file_upload",
+        ],
+        required=True,
+    )
+    parser.add_argument(
+        "--update",
+        action="store_true",
+        default=False,
+    )
+    args = parser.parse_args()
+
+    main(args)

optexity-0.1.4/optexity/examples/download_pdf_url.py

@@ -0,0 +1,29 @@
+from optexity.schema.automation import Automation
+
+description = "Download PDF URL Example"
+endpoint_name = "download_pdf_url"
+automation_json = {
+    "url": "about:blank",
+    "parameters": {
+        "input_parameters": {
+            "pdf_url": ["https://s24.q4cdn.com/216390268/files/doc_downloads/test.pdf"]
+        },
+        "generated_parameters": {},
+    },
+    "nodes": [
+        {
+            "type": "action_node",
+            "interaction_action": {"go_to_url": {"url": "{pdf_url[0]}"}},
+            "end_sleep_time": 1.0,
+        },
+        {
+            "type": "action_node",
+            "interaction_action": {
+                "download_url_as_pdf": {"download_filename": "example.pdf"}
+            },
+            "end_sleep_time": 1.0,
+        },
+    ],
+}
+
+automation = Automation.model_validate(automation_json)

optexity-0.1.4/optexity/examples/extract_price_stockanalysis.py

@@ -0,0 +1,44 @@
+from optexity.schema.automation import Automation
+
+description = "Extract stock price from StockAnalysis"
+endpoint_name = "extract_price_stockanalysis"
+automation_json = {
+    "url": "https://stockanalysis.com/",
+    "parameters": {
+        "input_parameters": {"stock_ticker": ["AAPL"]},
+        "generated_parameters": {},
+    },
+    "nodes": [
+        {
+            "interaction_action": {
+                "input_text": {
+                    "command": 'locator("#search-header")',
+                    "prompt_instructions": "Fill the input field with ID 'search-header' with the value of the 'stock_ticker' variable.",
+                    "input_text": "{stock_ticker[0]}",
+                }
+            }
+        },
+        {
+            "interaction_action": {
+                "click_element": {
+                    "prompt_instructions": "Click on the link with the name of the stock equivalent for {stock_ticker[0]}."
+                }
+            }
+        },
+        {
+            "extraction_action": {
+                "llm": {
+                    "source": ["screenshot"],
+                    "extraction_format": {
+                        "stock_name": "str",
+                        "stock_price": "str",
+                        "stock_symbol": "str",
+                    },
+                    "extraction_instructions": "Extract the stock price, stock name, and stock symbol from the webpage.",
+                }
+            }
+        },
+    ],
+}
+
+automation = Automation.model_validate(automation_json)

optexity-0.1.4/optexity/examples/file_upload.py

@@ -0,0 +1,59 @@
+from optexity.schema.automation import Automation
+
+description = "File Upload Example"
+endpoint_name = "file_upload"
+automation_json = {
+    "url": "https://www.azurespeed.com/Azure/UploadLargeFile",
+    "parameters": {
+        "input_parameters": {
+            "target_region_option": ["test_region"],
+            "file_path": ["/path/to/test/file.txt"],
+        },
+        "generated_parameters": {},
+    },
+    "nodes": [
+        {
+            "type": "action_node",
+            "interaction_action": {
+                "select_option": {
+                    "command": 'get_by_label("Target region")',
+                    "prompt_instructions": "Select an option from the field labeled 'Target region' with the value from the 'target_region_option' variable.",
+                    "select_values": ["{target_region_option[0]}"],
+                }
+            },
+            "end_sleep_time": 1.0,
+        },
+        {
+            "type": "action_node",
+            "interaction_action": {
+                "upload_file": {
+                    "command": 'get_by_role("button", name="Test file")',
+                    "prompt_instructions": "Click on the 'Test file' button.",
+                    "file_path": "{file_path[0]}",
+                }
+            },
+            "end_sleep_time": 1.0,
+        },
+        {
+            "type": "action_node",
+            "interaction_action": {
+                "click_element": {
+                    "command": 'get_by_role("button", name="Start test")',
+                    "prompt_instructions": "Click the 'Start test' button",
+                }
+            },
+            "end_sleep_time": 1.0,
+        },
+        {
+            "type": "action_node",
+            "assertion_action": {
+                "llm": {
+                    "extraction_instructions": "Check if the file upload was successful"
+                }
+            },
+            "before_sleep_time": 10.0,
+            "end_sleep_time": 0.0,
+        },
+    ],
+}
+automation = Automation.model_validate(automation_json)

optexity-0.1.4/optexity/examples/i94.py

@@ -0,0 +1,126 @@
+from optexity.schema.automation import Automation
+
+description = "I94 Example"
+endpoint_name = "i94"
+automation_json = {
+    "url": "https://i94.cbp.dhs.gov/search/recent-search",
+    "nodes": [
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "before_sleep_time": 3,
+            "python_script_action": {
+                "execution_code": 'async def code_fn(page):\n    print("entering code_fn")\n    await page.evaluate(\n        """  const el = document.querySelector(\'mat-dialog-content\');  if (el) el.scrollTop = el.scrollHeight;"""\n    )\n    print("exiting code_fn")\n'
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "click_element": {
+                    "command": 'get_by_role("button", name="I ACKNOWLEDGE AND AGREE")',
+                    "prompt_instructions": "Click the I ACKNOWLEDGE AND AGREE button",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "input_text": {
+                    "command": 'get_by_role("textbox", name="Please enter your first name")',
+                    "input_text": "{first_name[0]}",
+                    "prompt_instructions": "Enter the First Name",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "input_text": {
+                    "command": 'get_by_role("textbox", name="Please enter your last name")',
+                    "input_text": "{last_name[0]}",
+                    "prompt_instructions": "Enter the Last Name",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "input_text": {
+                    "command": 'get_by_role("textbox", name="Date of Birth")',
+                    "input_text": "{date_of_birth[0]}",
+                    "prompt_instructions": "Enter the Date of Birth",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "input_text": {
+                    "command": 'get_by_role("textbox", name="Please enter your document")',
+                    "input_text": "{document_number[0]}",
+                    "prompt_instructions": "Enter the Document Number",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "input_text": {
+                    "command": 'get_by_role("combobox", name="Please enter your document")',
+                    "input_text": "{nationality[0]}",
+                    "prompt_instructions": "Enter the Nationality",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "click_element": {
+                    "prompt_instructions": "Select {nationality[0]} from the options. Be careful to select the correct option. which will be of the format `nationality (code)`"
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 1,
+            "interaction_action": {
+                "click_element": {
+                    "command": 'get_by_role("button", name="Click to submit the form")',
+                    "prompt_instructions": "Click the Submit button",
+                }
+            },
+        },
+        {
+            "type": "action_node",
+            "end_sleep_time": 0,
+            "before_sleep_time": 3,
+            "extraction_action": {
+                "network_call": {
+                    "extract_from": "response",
+                    "url_pattern": "https://i94.cbp.dhs.gov/api/services/i94/recent",
+                }
+            },
+        },
+    ],
+    "parameters": {
+        "input_parameters": {
+            "last_name": ["Last Name"],
+            "first_name": ["First Name"],
+            "nationality": ["IND"],
+            "date_of_birth": ["MM/DD/YYYY"],
+            "document_number": ["Document Number"],
+        },
+        "generated_parameters": {},
+    },
+    "browser_channel": "chrome",
+}
+
+
+automation = Automation.model_validate(automation_json)