browser-service 0.0.1__tar.gz

browser_service-0.0.1/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2025-11-06
+
+### Added
+- Initial release of browser-service package
+- AI-powered element identification using browser-use
+- Multiple locator strategies (ID, data-testid, name, aria-label, CSS, XPath)
+- Playwright-based locator validation
+- Unified workflow mode for browser sessions
+- Custom actions for smart locator finding
+- Comprehensive configuration management
+- Browser session lifecycle management
+- Locator generation and validation utilities
+- Task processing and workflow execution
+- API route registration and handlers
+- Metrics and logging utilities
+- Support for Robot Framework Browser and Selenium libraries
+
+### Changed
+- Extracted from monolithic browser_use_service.py
+- Modularized into separate components for better maintainability
+
+### Fixed
+- Windows UTF-8 compatibility issues
+- Resource cleanup on workflow completion
+
+## [Unreleased]
+
+### Planned
+- Additional locator strategies
+- Enhanced error recovery
+- Performance optimizations
+- Extended documentation
+- More comprehensive test coverage

browser_service-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Dhruvil Upendra Vyas
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

browser_service-0.0.1/MANIFEST.in

@@ -0,0 +1,18 @@
+# Include documentation
+include README.md
+include LICENSE
+include CHANGELOG.md
+
+# Include requirements
+include requirements.txt
+
+# Include package data
+recursive-include browser_service *.py
+recursive-include browser_service py.typed
+
+# Exclude unnecessary files
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude .DS_Store
+global-exclude *.so
+global-exclude *.dylib

browser_service-0.0.1/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: browser-service
+Version: 0.0.1
+Summary: Browser automation service with AI-powered element identification and locator generation
+Home-page: https://github.com/monkscode/browser-service
+Author: monkscode
+Author-email: browser-service <1dhruvilvyas@gmail.com>
+Maintainer-email: browser-service <1dhruvilvyas@gmail.com>, browser-service <patel.devasy.23@gmail.com>
+License: Apache 2.0
+Project-URL: Homepage, https://github.com/monkscode/browser-service
+Project-URL: Documentation, https://github.com/monkscode/browser-service#readme
+Project-URL: Repository, https://github.com/monkscode/browser-service
+Project-URL: Bug Tracker, https://github.com/monkscode/browser-service/issues
+Keywords: browser,automation,testing,locators,selenium,playwright,robot-framework,ai
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: browser-use>=0.7.10
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: langchain-google-genai>=0.0.5
+Requires-Dist: flask>=3.0.0
+Requires-Dist: requests>=2.31.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: flake8>=6.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: isort>=5.12; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.21; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Browser Service - PyPI Package
+
+AI-powered browser automation service with intelligent element identification and locator generation.
+
+## 🎯 Overview
+
+Browser Service provides an intelligent API for browser automation with AI-powered element locator generation. It simplifies web automation by automatically identifying and generating reliable selectors for web elements.
+
+## ⚙️ Installation
+
+```bash
+pip install browser-service
+```
+
+## 🔧 Prerequisites
+
+You'll need:
+- Python 3.8+ installed
+
+## 📦 Package Contents
+
+The package includes:
+```
+browser_service/
+├── __init__.py          # Package entry point
+├── config.py            # Configuration management
+├── agent/               # Custom actions
+├── api/                 # HTTP API endpoints
+├── browser/             # Browser lifecycle
+├── locators/            # Locator generation
+├── prompts/             # Prompt templates
+├── tasks/               # Task processing
+└── utils/               # Utilities
+```
+
+## ✅ What's Included
+
+- ✅ Automated PyPI publishing via GitHub Actions
+- ✅ Auto-versioning for each commit to main
+- ✅ Manual release capability for major versions
+- ✅ Full documentation and examples
+- ✅ Comprehensive test suite
+
+## 🆘 Development
+
+For development and contribution:

browser_service-0.0.1/README.md

@@ -0,0 +1,46 @@
+# Browser Service - PyPI Package
+
+AI-powered browser automation service with intelligent element identification and locator generation.
+
+## 🎯 Overview
+
+Browser Service provides an intelligent API for browser automation with AI-powered element locator generation. It simplifies web automation by automatically identifying and generating reliable selectors for web elements.
+
+## ⚙️ Installation
+
+```bash
+pip install browser-service
+```
+
+## 🔧 Prerequisites
+
+You'll need:
+- Python 3.8+ installed
+
+## 📦 Package Contents
+
+The package includes:
+```
+browser_service/
+├── __init__.py          # Package entry point
+├── config.py            # Configuration management
+├── agent/               # Custom actions
+├── api/                 # HTTP API endpoints
+├── browser/             # Browser lifecycle
+├── locators/            # Locator generation
+├── prompts/             # Prompt templates
+├── tasks/               # Task processing
+└── utils/               # Utilities
+```
+
+## ✅ What's Included
+
+- ✅ Automated PyPI publishing via GitHub Actions
+- ✅ Auto-versioning for each commit to main
+- ✅ Manual release capability for major versions
+- ✅ Full documentation and examples
+- ✅ Comprehensive test suite
+
+## 🆘 Development
+
+For development and contribution:

browser_service-0.0.1/browser_service/__init__.py

@@ -0,0 +1,53 @@
+"""
+Browser Service Package
+
+This package contains modular components for the browser automation service,
+extracted from the monolithic browser_use_service.py file.
+
+Modules:
+    - config: Configuration management (BatchConfig, LocatorConfig, LLMConfig)
+    - utils: Shared utility functions (JSON parsing, metrics, logging)
+    - browser: Browser lifecycle and resource management
+    - locators: Locator generation, validation, and extraction
+    - prompts: Prompt building for AI agents
+    - agent: Custom action definitions and registration
+    - tasks: Task processing and workflow execution
+    - api: HTTP API endpoints and request handling
+
+Usage:
+    # Import global config instance
+    from browser_service import config
+
+    # Import specific components
+    from browser_service.config import BrowserServiceConfig, BatchConfig, LocatorConfig, LLMConfig
+    from browser_service.browser import BrowserSessionManager, cleanup_browser_resources
+    from browser_service.locators import generate_locators_from_attributes, validate_locator_playwright
+    from browser_service.prompts import build_workflow_prompt, build_system_prompt
+    from browser_service.agent import find_unique_locator_action, register_custom_actions
+    from browser_service.tasks import process_workflow_task, TaskProcessor
+    from browser_service.api import register_routes
+    from browser_service.utils import setup_logging, record_workflow_metrics
+"""
+
+__version__ = "1.0.0"
+
+# Import key components for convenient access
+from browser_service.config import (
+    config,
+    BrowserServiceConfig,
+    BatchConfig,
+    LocatorConfig,
+    LLMConfig
+)
+
+__all__ = [
+    # Version
+    '__version__',
+
+    # Configuration
+    'config',
+    'BrowserServiceConfig',
+    'BatchConfig',
+    'LocatorConfig',
+    'LLMConfig',
+]

browser_service-0.0.1/browser_service/agent/__init__.py

@@ -0,0 +1,24 @@
+"""
+Agent management module for browser service.
+
+This module provides custom action definitions and registration for the browser-use agent.
+Custom actions allow the agent to call deterministic Python code for locator finding and validation.
+
+Key Components:
+- actions.py: Custom action implementations (find_unique_locator_action)
+- registration.py: Custom action registration with browser-use agent
+
+Usage:
+    from browser_service.agent import find_unique_locator_action, register_custom_actions
+
+    # Register custom actions with agent
+    success = register_custom_actions(agent, page=None)
+"""
+
+from browser_service.agent.actions import find_unique_locator_action
+from browser_service.agent.registration import register_custom_actions
+
+__all__ = [
+    'find_unique_locator_action',
+    'register_custom_actions'
+]