search-api-webui 0.1.2__tar.gz → 0.1.4__tar.gz

{search_api_webui-0.1.2 → search_api_webui-0.1.4}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2026 querit-ai
+Copyright (c) 2026 QUERIT PRIVATE LIMITED
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: search-api-webui
-Version: 0.1.2
+Version: 0.1.4
 Summary: A Search API WebUI for Querit, You, and other search providers.
 Project-URL: Homepage, https://github.com/querit-ai/search-api-webui
 Project-URL: Repository, https://github.com/querit-ai/search-api-webui.git
@@ -24,17 +24,17 @@ Description-Content-Type: text/markdown
 
 # Search API WebUI
 
-A lightweight, local WebUI for testing and visualizing Search APIs (Querit, YDC, etc.).
+A lightweight, local WebUI for testing and visualizing Search APIs (Querit, You, etc.).
 
 (images)
 
 ## Features
 
-**Search**: Support for Querit, You.com, and generic Search APIs via configuration.
-**Performance Metrics**: Real-time display of request latency and payload size.
-**Visual Rendering**: Renders standard search results (Title, Snippet, URL) in a clean card layout.
-**Configurable**: Easy-to-edit providers.yaml to add or modify search providers.
-**Secure**: API Keys are stored locally in user_config.json and never committed.
+* **Search**: Support for [Querit.ai](https://www.querit.ai/en/docs/reference/post), [You.com](https://docs.you.com/api-reference/search/v1-search), and generic Search APIs via configuration.
+* **Performance Metrics**: Real-time display of request latency and payload size.
+* **Visual Rendering**: Renders standard search results (Title, Snippet, URL) in a clean card layout.
+* **Configurable**: Easy-to-edit providers.yaml to add or modify search providers.
+* **Secure**: API Keys are stored locally in your $HOME folder.
 ## Installation
 
 Use this method if you just want to run the tool without modifying the code.
@@ -54,25 +54,26 @@ pip install search-api-webui
 search-api-webui
 ```
 
-Open your browser at http://localhost:8889.
-
 ## Development
 
 Use this method if you want to contribute to the code or build from source.
 
 ### Prerequisites
 
-Python 3.7+
-Node.js & npm (for building the frontend)
+* Python 3.7+
+* Node.js & npm (for building the frontend)
+
 ### Setup Steps
 
 **Clone the repository**
+
 ```
 git clone https://github.com/querit-ai/search-api-webui.git
 cd search-api-webui
 ```
 
 **Build Frontend**
+
 ```
 cd frontend
 npm install
@@ -80,23 +81,24 @@ npm run build
 cd …
 ```
 
-**Install Backend (Editable Mode)**
+**Install search-api-webui (Editable Mode)**
+
 ```
 pip install -e .
 ```
 
 **Run the Server**
+
 ```
-python -m backend.app
+python -m search_api_webui.app
 ```
 
 ## Configuration
 
 ### Add API Keys
 
-Open the WebUI settings page (click the gear icon).
-Enter your API Key for the selected provider (e.g., Querit).
-Keys are saved locally in user_config.json.
+Open the WebUI settings page (click the gear icon). Enter your API Key for the selected provider (e.g., Querit). Keys are saved locally in $HOME/.search-api-webui/config.json.
+
 ### Add New Providers
 
 Edit providers.yaml in the root directory to add custom API endpoints. The system uses JMESPath to map JSON responses to the UI.

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

@@ -1,16 +1,16 @@
 # Search API WebUI
 
-A lightweight, local WebUI for testing and visualizing Search APIs (Querit, YDC, etc.).
+A lightweight, local WebUI for testing and visualizing Search APIs (Querit, You, etc.).
 
 (images)
 
 ## Features
 
-**Search**: Support for Querit, You.com, and generic Search APIs via configuration.
-**Performance Metrics**: Real-time display of request latency and payload size.
-**Visual Rendering**: Renders standard search results (Title, Snippet, URL) in a clean card layout.
-**Configurable**: Easy-to-edit providers.yaml to add or modify search providers.
-**Secure**: API Keys are stored locally in user_config.json and never committed.
+* **Search**: Support for [Querit.ai](https://www.querit.ai/en/docs/reference/post), [You.com](https://docs.you.com/api-reference/search/v1-search), and generic Search APIs via configuration.
+* **Performance Metrics**: Real-time display of request latency and payload size.
+* **Visual Rendering**: Renders standard search results (Title, Snippet, URL) in a clean card layout.
+* **Configurable**: Easy-to-edit providers.yaml to add or modify search providers.
+* **Secure**: API Keys are stored locally in your $HOME folder.
 ## Installation
 
 Use this method if you just want to run the tool without modifying the code.
@@ -30,25 +30,26 @@ pip install search-api-webui
 search-api-webui
 ```
 
-Open your browser at http://localhost:8889.
-
 ## Development
 
 Use this method if you want to contribute to the code or build from source.
 
 ### Prerequisites
 
-Python 3.7+
-Node.js & npm (for building the frontend)
+* Python 3.7+
+* Node.js & npm (for building the frontend)
+
 ### Setup Steps
 
 **Clone the repository**
+
 ```
 git clone https://github.com/querit-ai/search-api-webui.git
 cd search-api-webui
 ```
 
 **Build Frontend**
+
 ```
 cd frontend
 npm install
@@ -56,23 +57,24 @@ npm run build
 cd …
 ```
 
-**Install Backend (Editable Mode)**
+**Install search-api-webui (Editable Mode)**
+
 ```
 pip install -e .
 ```
 
 **Run the Server**
+
 ```
-python -m backend.app
+python -m search_api_webui.app
 ```
 
 ## Configuration
 
 ### Add API Keys
 
-Open the WebUI settings page (click the gear icon).
-Enter your API Key for the selected provider (e.g., Querit).
-Keys are saved locally in user_config.json.
+Open the WebUI settings page (click the gear icon). Enter your API Key for the selected provider (e.g., Querit). Keys are saved locally in $HOME/.search-api-webui/config.json.
+
 ### Add New Providers
 
 Edit providers.yaml in the root directory to add custom API endpoints. The system uses JMESPath to map JSON responses to the UI.

{search_api_webui-0.1.2 → search_api_webui-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "search-api-webui"
-version = "0.1.2"
+version = "0.1.4"
 description = "A Search API WebUI for Querit, You, and other search providers."
 readme = "README.md"
 requires-python = ">=3.7"
@@ -35,19 +35,17 @@ Repository = "https://github.com/querit-ai/search-api-webui.git"
 Issues = "https://github.com/querit-ai/search-api-webui/issues"
 
 [project.scripts]
-search-api-webui = "backend.app:main"
+search-api-webui = "search_api_webui.app:main"
 
 [tool.hatch.build.targets.wheel]
-packages = ["backend"]
+packages = ["search_api_webui"]
 
 [tool.hatch.build.targets.sdist]
 include = [
-    "backend",
-    "providers.yaml",
+    "search_api_webui",
     "README.md",
     "LICENSE"
 ]
-artifacts = ["backend/static"]
 exclude = [
     "frontend",
     "user_config.json",
@@ -55,5 +53,4 @@ exclude = [
 ]
 
 [tool.hatch.build.targets.wheel.force-include]
-"backend/static" = "backend/static"
-"providers.yaml" = "backend/providers.yaml"
+"frontend/dist" = "search_api_webui/static"

search_api_webui-0.1.4/search_api_webui/__init__.py

@@ -0,0 +1,20 @@
+# Copyright (c) 2026 QUERIT PRIVATE LIMITED
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# 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.
+

{search_api_webui-0.1.2/backend → search_api_webui-0.1.4/search_api_webui}/app.py

@@ -1,12 +1,38 @@
+# Copyright (c) 2026 QUERIT PRIVATE LIMITED
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# 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.
+
 import json
 import os
+import webbrowser
 from pathlib import Path
 from flask import Flask, request, jsonify, send_from_directory
 from flask_cors import CORS
-from backend.providers import load_providers
+from search_api_webui.providers import load_providers
 
 CURRENT_DIR = Path(__file__).resolve().parent
+
 STATIC_FOLDER = CURRENT_DIR / 'static'
+if not STATIC_FOLDER.exists():
+    DEV_FRONTEND_DIST = CURRENT_DIR.parent / 'frontend' / 'dist'
+    if DEV_FRONTEND_DIST.exists():
+        STATIC_FOLDER = DEV_FRONTEND_DIST
 
 app = Flask(__name__, static_folder='static')
 CORS(app)
@@ -151,15 +177,18 @@ def main():
     import argparse
     parser = argparse.ArgumentParser(description="Search API WebUI")
     parser.add_argument("--port", type=int, default=8889, help="Port to run the server on")
-    parser.add_argument("--host", type=str, default="0.0.0.0", help="Host to run the server on")
+    parser.add_argument("--host", type=str, default="127.0.0.1", help="Host to run the server on")
     args = parser.parse_args()
 
+    url = f"http://{args.host}:{args.port}"
     print(f"Starting Search API WebUI...")
     print(f"  - Config Storage: {USER_CONFIG_JSON}")
-    print(f"  - Serving on: http://{args.host}:{args.port}")
+    print(f"  - Serving on: {url}")
+
+    # Open browser automatically after a short delay to ensure server is ready
+    webbrowser.open(url)
 
     app.run(host=args.host, port=args.port)
 
 if __name__ == "__main__":
     main()
-

search_api_webui-0.1.4/search_api_webui/providers/__init__.py

@@ -0,0 +1,54 @@
+# Copyright (c) 2026 QUERIT PRIVATE LIMITED
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# 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.
+
+import os
+import yaml
+from .generic import GenericProvider
+from .querit import QueritSdkProvider
+
+def load_providers(file_path='providers.yaml'):
+    """
+    Parses the YAML configuration file and instantiates the appropriate provider classes.
+    
+    Args:
+        file_path (str): Path to the providers configuration file.
+        
+    Returns:
+        dict: A dictionary mapping provider names to their initialized instances.
+    """
+    if not os.path.exists(file_path):
+        print(f"Warning: Provider config file not found at {file_path}")
+        return {}
+        
+    with open(file_path, 'r', encoding='utf-8') as f:
+        configs = yaml.safe_load(f)
+
+    providers = {}
+    for name, conf in configs.items():
+        conf['name'] = name
+        provider_type = conf.get('type', 'generic')
+
+        # Instantiate specific provider based on type or name
+        if provider_type == 'querit_sdk':
+            providers[name] = QueritSdkProvider(conf)
+        else:
+            providers[name] = GenericProvider(conf)
+
+    return providers

search_api_webui-0.1.4/search_api_webui/providers/base.py

@@ -0,0 +1,45 @@
+# Copyright (c) 2026 QUERIT PRIVATE LIMITED
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# 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.
+
+from abc import ABC, abstractmethod
+
+class BaseProvider(ABC):
+    """
+    Abstract base class for all search providers.
+    Enforces a standard interface for executing search queries.
+    """
+
+    @abstractmethod
+    def search(self, query, api_key, **kwargs):
+        """
+        Execute a search request against the provider.
+
+        Args:
+            query (str): The search keywords.
+            api_key (str): The API Key required for authentication.
+            **kwargs: Arbitrary keyword arguments (e.g., 'limit', 'language', 'api_url').
+
+        Returns:
+            dict: A standardized dictionary containing:
+                - 'results': List of dicts with 'title', 'url', 'snippet'.
+                - 'metrics': Dict with 'latency_ms' and 'size_bytes'.
+                - 'error': (Optional) Error message string if occurred.
+        """
+        pass

{search_api_webui-0.1.2/backend → search_api_webui-0.1.4/search_api_webui}/providers/generic.py

@@ -1,3 +1,23 @@
+# Copyright (c) 2026 QUERIT PRIVATE LIMITED
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# 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.
+
 import time
 import requests
 import jmespath

{search_api_webui-0.1.2/backend → search_api_webui-0.1.4/search_api_webui}/providers/querit.py

@@ -1,3 +1,23 @@
+# Copyright (c) 2026 QUERIT PRIVATE LIMITED
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# 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.
+
 import time
 import json
 from querit import QueritClient

search_api_webui-0.1.2/backend/providers/__init__.py

@@ -1,34 +0,0 @@
-import os
-import yaml
-from .generic import GenericProvider
-from .querit import QueritSdkProvider
-
-def load_providers(file_path='providers.yaml'):
-    """
-    Parses the YAML configuration file and instantiates the appropriate provider classes.
-    
-    Args:
-        file_path (str): Path to the providers configuration file.
-        
-    Returns:
-        dict: A dictionary mapping provider names to their initialized instances.
-    """
-    if not os.path.exists(file_path):
-        print(f"Warning: Provider config file not found at {file_path}")
-        return {}
-        
-    with open(file_path, 'r', encoding='utf-8') as f:
-        configs = yaml.safe_load(f)
-
-    providers = {}
-    for name, conf in configs.items():
-        conf['name'] = name
-        provider_type = conf.get('type', 'generic')
-
-        # Instantiate specific provider based on type or name
-        if provider_type == 'querit_sdk':
-            providers[name] = QueritSdkProvider(conf)
-        else:
-            providers[name] = GenericProvider(conf)
-
-    return providers

search_api_webui-0.1.2/backend/providers/base.py

@@ -1,25 +0,0 @@
-from abc import ABC, abstractmethod
-
-class BaseProvider(ABC):
-    """
-    Abstract base class for all search providers.
-    Enforces a standard interface for executing search queries.
-    """
-
-    @abstractmethod
-    def search(self, query, api_key, **kwargs):
-        """
-        Execute a search request against the provider.
-
-        Args:
-            query (str): The search keywords.
-            api_key (str): The API Key required for authentication.
-            **kwargs: Arbitrary keyword arguments (e.g., 'limit', 'language', 'api_url').
-
-        Returns:
-            dict: A standardized dictionary containing:
-                - 'results': List of dicts with 'title', 'url', 'snippet'.
-                - 'metrics': Dict with 'latency_ms' and 'size_bytes'.
-                - 'error': (Optional) Error message string if occurred.
-        """
-        pass