webscout 8.3.1__py3-none-any.whl → 8.3.2__py3-none-any.whl

webscout/auth/templates/static/ui.js

@@ -0,0 +1,374 @@
+/**
+ * WebScout API Documentation - UI Utilities
+ * Handles UI interactions, animations, and helper functions
+ */
+
+// UI utility functions
+window.WebScoutUI = {
+    // Show loading state on button
+    showLoading(button, loadingText = 'Loading...') {
+        if (!button) return '';
+        
+        const originalText = button.innerHTML;
+        button.disabled = true;
+        button.innerHTML = `
+            <div class="loading">
+                <div class="spinner"></div>
+                <span>${loadingText}</span>
+            </div>
+        `;
+        return originalText;
+    },
+    
+    // Hide loading state on button
+    hideLoading(button, originalText) {
+        if (!button || !originalText) return;
+        
+        button.disabled = false;
+        button.innerHTML = originalText;
+    },
+    
+    // Display API response
+    displayResponse(containerId, response) {
+        const container = document.getElementById(containerId);
+        if (!container) return;
+        
+        container.innerHTML = '';
+        container.classList.add('show');
+        
+        // Create response header
+        const header = document.createElement('div');
+        header.className = 'response-header';
+        
+        const statusClass = this.getStatusClass(response.status);
+        header.innerHTML = `
+            <div class="response-status">
+                <span class="status-code ${statusClass}">${response.status}</span>
+                <span class="status-text">${response.statusText}</span>
+            </div>
+            <div class="response-time">${response.responseTime}ms</div>
+        `;
+        
+        container.appendChild(header);
+        
+        // Create response body
+        const body = document.createElement('div');
+        body.className = 'response-body';
+        
+        const pre = document.createElement('pre');
+        pre.innerHTML = this.formatResponseData(response.data);
+        body.appendChild(pre);
+        
+        container.appendChild(body);
+    },
+    
+    // Display image generation response
+    displayImageResponse(containerId, response) {
+        const container = document.getElementById(containerId);
+        if (!container) return;
+        
+        container.innerHTML = '';
+        container.classList.add('show');
+        
+        // Create response header
+        const header = document.createElement('div');
+        header.className = 'response-header';
+        
+        const statusClass = this.getStatusClass(response.status);
+        header.innerHTML = `
+            <div class="response-status">
+                <span class="status-code ${statusClass}">${response.status}</span>
+                <span class="status-text">${response.statusText}</span>
+            </div>
+            <div class="response-time">${response.responseTime}ms</div>
+        `;
+        
+        container.appendChild(header);
+        
+        // Create response body
+        const body = document.createElement('div');
+        body.className = 'response-body';
+        
+        if (response.status === 200 && response.data.data) {
+            // Display images
+            const imagesContainer = document.createElement('div');
+            imagesContainer.className = 'images-container';
+            imagesContainer.style.cssText = `
+                display: grid;
+                grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
+                gap: 1rem;
+                margin-bottom: 1rem;
+            `;
+            
+            response.data.data.forEach((image, index) => {
+                const imageCard = document.createElement('div');
+                imageCard.className = 'image-card';
+                imageCard.style.cssText = `
+                    border: 1px solid var(--border-color);
+                    border-radius: var(--radius);
+                    overflow: hidden;
+                    background: var(--surface-color);
+                `;
+                
+                imageCard.innerHTML = `
+                    <img src="${image.url}" alt="Generated image ${index + 1}" 
+                         style="width: 100%; height: auto; display: block;">
+                    <div style="padding: 0.5rem; text-align: center;">
+                        <a href="${image.url}" target="_blank" 
+                           style="color: var(--primary-color); text-decoration: none; font-size: 0.875rem;">
+                            🔗 Open Full Size
+                        </a>
+                    </div>
+                `;
+                
+                imagesContainer.appendChild(imageCard);
+            });
+            
+            body.appendChild(imagesContainer);
+        }
+        
+        // Add JSON response
+        const pre = document.createElement('pre');
+        pre.innerHTML = this.formatResponseData(response.data);
+        body.appendChild(pre);
+        
+        container.appendChild(body);
+    },
+    
+    // Get CSS class for status code
+    getStatusClass(status) {
+        if (status >= 200 && status < 300) return 'status-200';
+        if (status >= 400 && status < 500) return 'status-400';
+        if (status >= 500) return 'status-500';
+        return 'status-400';
+    },
+    
+    // Format response data with syntax highlighting
+    formatResponseData(data) {
+        if (typeof data === 'string') {
+            try {
+                data = JSON.parse(data);
+            } catch (e) {
+                return this.escapeHtml(data);
+            }
+        }
+        
+        const jsonString = JSON.stringify(data, null, 2);
+        return this.highlightJSON(jsonString);
+    },
+    
+    // Simple JSON syntax highlighting
+    highlightJSON(json) {
+        return json
+            .replace(/(".*?")\s*:/g, '<span class="json-key">$1</span>:')
+            .replace(/:\s*(".*?")/g, ': <span class="json-string">$1</span>')
+            .replace(/:\s*(\d+\.?\d*)/g, ': <span class="json-number">$1</span>')
+            .replace(/:\s*(true|false)/g, ': <span class="json-boolean">$1</span>')
+            .replace(/:\s*(null)/g, ': <span class="json-null">$1</span>');
+    },
+    
+    // Escape HTML
+    escapeHtml(text) {
+        const div = document.createElement('div');
+        div.textContent = text;
+        return div.innerHTML;
+    },
+    
+    // Search models
+    searchModels(query) {
+        const cards = document.querySelectorAll('.model-card');
+        const noResults = document.getElementById('no-models');
+        let visibleCount = 0;
+        
+        cards.forEach(card => {
+            const modelName = card.dataset.modelName || '';
+            const isVisible = modelName.includes(query.toLowerCase());
+            card.style.display = isVisible ? 'block' : 'none';
+            if (isVisible) visibleCount++;
+        });
+        
+        if (noResults) {
+            noResults.style.display = visibleCount === 0 ? 'block' : 'none';
+        }
+    },
+    
+    // Filter models
+    filterModels(filter) {
+        const cards = document.querySelectorAll('.model-card');
+        const noResults = document.getElementById('no-models');
+        let visibleCount = 0;
+        
+        cards.forEach(card => {
+            const modelType = card.dataset.modelType || '';
+            const modelName = card.dataset.modelName || '';
+            
+            let isVisible = filter === 'all';
+            
+            if (filter === 'chat') {
+                isVisible = modelType === 'model' || modelName.includes('gpt') || modelName.includes('claude');
+            } else if (filter === 'image') {
+                isVisible = modelName.includes('dall-e') || modelName.includes('stable');
+            } else if (filter === 'embedding') {
+                isVisible = modelName.includes('embedding') || modelName.includes('ada');
+            }
+            
+            card.style.display = isVisible ? 'block' : 'none';
+            if (isVisible) visibleCount++;
+        });
+        
+        if (noResults) {
+            noResults.style.display = visibleCount === 0 ? 'block' : 'none';
+        }
+    },
+    
+    // Download Postman collection
+    downloadPostmanCollection() {
+        const collection = {
+            info: {
+                name: "WebScout API",
+                description: "WebScout OpenAI-compatible API collection",
+                schema: "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+            },
+            item: [
+                {
+                    name: "Chat Completions",
+                    request: {
+                        method: "POST",
+                        header: [
+                            {
+                                key: "Authorization",
+                                value: "Bearer {{api_key}}",
+                                type: "text"
+                            },
+                            {
+                                key: "Content-Type",
+                                value: "application/json",
+                                type: "text"
+                            }
+                        ],
+                        body: {
+                            mode: "raw",
+                            raw: JSON.stringify({
+                                model: "gpt-3.5-turbo",
+                                messages: [
+                                    {
+                                        role: "user",
+                                        content: "Hello, how are you?"
+                                    }
+                                ],
+                                temperature: 0.7,
+                                max_tokens: 150
+                            }, null, 2)
+                        },
+                        url: {
+                            raw: "{{base_url}}/v1/chat/completions",
+                            host: ["{{base_url}}"],
+                            path: ["v1", "chat", "completions"]
+                        }
+                    }
+                },
+                {
+                    name: "List Models",
+                    request: {
+                        method: "GET",
+                        header: [
+                            {
+                                key: "Authorization",
+                                value: "Bearer {{api_key}}",
+                                type: "text"
+                            }
+                        ],
+                        url: {
+                            raw: "{{base_url}}/v1/models",
+                            host: ["{{base_url}}"],
+                            path: ["v1", "models"]
+                        }
+                    }
+                },
+                {
+                    name: "Generate Image",
+                    request: {
+                        method: "POST",
+                        header: [
+                            {
+                                key: "Authorization",
+                                value: "Bearer {{api_key}}",
+                                type: "text"
+                            },
+                            {
+                                key: "Content-Type",
+                                value: "application/json",
+                                type: "text"
+                            }
+                        ],
+                        body: {
+                            mode: "raw",
+                            raw: JSON.stringify({
+                                prompt: "A beautiful sunset over mountains",
+                                model: "dall-e-2",
+                                size: "512x512",
+                                n: 1
+                            }, null, 2)
+                        },
+                        url: {
+                            raw: "{{base_url}}/v1/images/generations",
+                            host: ["{{base_url}}"],
+                            path: ["v1", "images", "generations"]
+                        }
+                    }
+                }
+            ],
+            variable: [
+                {
+                    key: "base_url",
+                    value: window.WEBSCOUT_CONFIG?.baseUrl || "http://localhost:8000"
+                },
+                {
+                    key: "api_key",
+                    value: "your-api-key-here"
+                }
+            ]
+        };
+        
+        const blob = new Blob([JSON.stringify(collection, null, 2)], { type: 'application/json' });
+        const url = URL.createObjectURL(blob);
+        const a = document.createElement('a');
+        a.href = url;
+        a.download = 'webscout-api.postman_collection.json';
+        document.body.appendChild(a);
+        a.click();
+        document.body.removeChild(a);
+        URL.revokeObjectURL(url);
+        
+        WebScoutApp.showToast('Postman collection downloaded!', 'success');
+    }
+};
+
+// Global functions for backward compatibility
+function showLoading(button, loadingText) {
+    return WebScoutUI.showLoading(button, loadingText);
+}
+
+function hideLoading(button, originalText) {
+    WebScoutUI.hideLoading(button, originalText);
+}
+
+function displayResponse(containerId, response) {
+    WebScoutUI.displayResponse(containerId, response);
+}
+
+function displayImageResponse(containerId, response) {
+    WebScoutUI.displayImageResponse(containerId, response);
+}
+
+function searchModels(query) {
+    WebScoutUI.searchModels(query);
+}
+
+function filterModels(filter) {
+    WebScoutUI.filterModels(filter);
+}
+
+function downloadPostmanCollection() {
+    WebScoutUI.downloadPostmanCollection();
+}

webscout/auth/templates/swagger_ui.html

@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{{ title }} - Swagger UI</title>
+    <link rel="icon" type="image/x-icon" href="/static/favicon.ico">
+
+    <!-- Google Fonts -->
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700;800&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet">
+
+    <!-- Highlight.js for syntax highlighting -->
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+
+    <!-- Custom Styles -->
+    <link rel="stylesheet" href="/static/styles.css">
+
+    <!-- SEO Meta Tags -->
+    <meta name="description" content="{{ description }} - Modern OpenAI API compatible interface with comprehensive documentation">
+    <meta name="keywords" content="API, OpenAI, Swagger, Documentation, REST, WebScout">
+    <meta name="author" content="WebScout">
+
+    <!-- Open Graph Meta Tags -->
+    <meta property="og:title" content="{{ title }} - Swagger UI">
+    <meta property="og:description" content="{{ description }}">
+    <meta property="og:type" content="website">
+    <meta property="og:url" content="{{ base_url }}">
+
+    <!-- Twitter Card Meta Tags -->
+    <meta name="twitter:card" content="summary_large_image">
+    <meta name="twitter:title" content="{{ title }} - Swagger UI">
+    <meta name="twitter:description" content="{{ description }}">
+</head>
+<body>
+    <!-- Modern Scroll Indicator -->
+    <div class="scroll-indicator">
+        <div class="scroll-progress" id="scroll-progress"></div>
+    </div>
+
+    <!-- Loading Screen -->
+    <div id="loading-screen" class="loading-screen">
+        <div class="loading-content">
+            <div class="loading-spinner"></div>
+            <h2>Loading WebScout API Documentation</h2>
+            <p>Preparing your API experience...</p>
+        </div>
+    </div>
+
+    <!-- Main Application -->
+    <div id="app" class="app">
+        <header class="header">
+            <div class="container">
+                <div class="header-content">
+                    <h1 class="header-title">
+                        <span class="header-icon">🚀</span>
+                        {{ title }}
+                    </h1>
+
+                    <p class="header-description">
+                        {{ description }} - A modern, powerful, and intuitive API interface
+                    </p>
+
+                    <div class="header-status">
+                        <span id="status-indicator" class="status-indicator">🟢</span>
+                        <span>API Status: Online</span>
+                        <span class="status-version">v{{ version }}</span>
+                    </div>
+                </div>
+            </div>
+        </header>
+
+        <main class="main-content">
+            <div class="container">
+                <nav class="nav-tabs" role="tablist">
+                    <button
+                        class="nav-tab active"
+                        role="tab"
+                        aria-selected="true"
+                        aria-controls="endpoints-panel"
+                        data-tab="endpoints"
+                        id="endpoints-tab"
+                    >
+                        <span class="nav-tab-icon">📡</span>
+                        <span class="nav-tab-text">API Endpoints</span>
+                    </button>
+
+                    <button
+                        class="nav-tab"
+                        role="tab"
+                        aria-selected="false"
+                        aria-controls="authentication-panel"
+                        data-tab="authentication"
+                        id="authentication-tab"
+                    >
+                        <span class="nav-tab-icon">🔐</span>
+                        <span class="nav-tab-text">Authentication</span>
+                    </button>
+
+                    <button
+                        class="nav-tab"
+                        role="tab"
+                        aria-selected="false"
+                        aria-controls="models-panel"
+                        data-tab="models"
+                        id="models-tab"
+                    >
+                        <span class="nav-tab-icon">🤖</span>
+                        <span class="nav-tab-text">Models</span>
+                    </button>
+
+                    <button
+                        class="nav-tab"
+                        role="tab"
+                        aria-selected="false"
+                        aria-controls="examples-panel"
+                        data-tab="examples"
+                        id="examples-tab"
+                    >
+                        <span class="nav-tab-icon">💡</span>
+                        <span class="nav-tab-text">Examples</span>
+                    </button>
+                </nav>
+
+                <div class="tab-container">
+                    {% include 'components/endpoints.html' %}
+                    {% include 'components/authentication.html' %}
+                    {% include 'components/models.html' %}
+                    {% include 'components/examples.html' %}
+                </div>
+            </div>
+        </main>
+
+        {% include 'components/footer.html' %}
+    </div>
+
+    <!-- Toast Notifications -->
+    <div id="toast-container" class="toast-container"></div>
+
+    <!-- Modal Container -->
+    <div id="modal-container" class="modal-container"></div>
+
+    <!-- Scripts -->
+    <script src="/static/particles.js"></script>
+    <script src="/static/icons.js"></script>
+    <script src="/static/ui.js"></script>
+    <script src="/static/api.js"></script>
+    <script src="/static/main.js"></script>
+
+    <!-- Initialize Application -->
+    <script>
+        // Global configuration
+        window.WEBSCOUT_CONFIG = {
+            title: '{{ title }}',
+            description: '{{ description }}',
+            version: '{{ version }}',
+            baseUrl: '{{ base_url }}',
+            modelCount: {{ model_count }},
+            providerCount: {{ provider_count }}
+        };
+
+        // Initialize app when DOM is loaded
+        document.addEventListener('DOMContentLoaded', function() {
+            WebScoutApp.init();
+        });
+    </script>
+</body>
+</html>

webscout/client.py

@@ -29,22 +29,52 @@ Exports:
 """
 
 from webscout.Provider.OPENAI import *
-from webscout.Provider.OPENAI.api import start_server, run_api
+
+# Import server utilities from the FastAPI-compatible backend
+try:
+    from webscout.auth.server import run_api
+    # Provide a simple alias for starting the server with default settings
+    def start_server(**kwargs):
+        """Start the Webscout OpenAI-compatible API server (FastAPI backend)."""
+        run_api(**kwargs)
+except ImportError:
+    # Fallback for environments where the backend is not available
+    def run_api(*args, **kwargs):
+        raise ImportError("webscout.auth.server.run_api is not available in this environment.")
+    def start_server(*args, **kwargs):
+        raise ImportError("webscout.auth.server.start_server is not available in this environment.")
 
 # ---
 # API Documentation
 #
 # start_server
 # -------------
-# def start_server(port: int = 8000, api_key: str = None, default_provider: str = None, base_url: str = None):
+# def start_server(
+#     port: int = 8000,
+#     host: str = "0.0.0.0",
+#     api_key: str = None,
+#     default_provider: str = None,
+#     base_url: str = None,
+#     workers: int = 1,
+#     log_level: str = 'info',
+#     debug: bool = False,
+#     no_auth: bool = False,
+#     no_rate_limit: bool = False
+# ):
 #     """
 #     Start the OpenAI-compatible API server with optional configuration.
 #
 #     Parameters:
 #         port (int, optional): The port to run the server on. Defaults to 8000.
+#         host (str, optional): Host address to bind the server. Defaults to '0.0.0.0'.
 #         api_key (str, optional): API key for authentication. If None, authentication is disabled.
 #         default_provider (str, optional): The default provider to use. If None, uses the package default.
 #         base_url (str, optional): Base URL prefix for the API (e.g., '/api/v1'). If None, no prefix is used.
+#         workers (int, optional): Number of worker processes. Defaults to 1.
+#         log_level (str, optional): Log level for the server ('debug', 'info', etc.). Defaults to 'info'.
+#         debug (bool, optional): Run the server in debug mode with auto-reload. Defaults to False.
+#         no_auth (bool, optional): Disable authentication (no API keys required). Defaults to False.
+#         no_rate_limit (bool, optional): Disable rate limiting (unlimited requests). Defaults to False.
 #
 #     Returns:
 #         None
@@ -52,7 +82,19 @@ from webscout.Provider.OPENAI.api import start_server, run_api
 #
 # run_api
 # -------
-# def run_api(host: str = '0.0.0.0', port: int = None, api_key: str = None, default_provider: str = None, base_url: str = None, debug: bool = False, show_available_providers: bool = True):
+# def run_api(
+#     host: str = '0.0.0.0',
+#     port: int = None,
+#     api_key: str = None,
+#     default_provider: str = None,
+#     base_url: str = None,
+#     debug: bool = False,
+#     workers: int = 1,
+#     log_level: str = 'info',
+#     show_available_providers: bool = True,
+#     no_auth: bool = False,
+#     no_rate_limit: bool = False,
+# ) -> None:
 #     """
 #     Advanced server startup for the OpenAI-compatible API server.
 #
@@ -63,7 +105,11 @@ from webscout.Provider.OPENAI.api import start_server, run_api
 #         default_provider (str, optional): The default provider to use. If None, uses the package default.
 #         base_url (str, optional): Base URL prefix for the API (e.g., '/api/v1'). If None, no prefix is used.
 #         debug (bool, optional): Run the server in debug mode with auto-reload. Defaults to False.
+#         workers (int, optional): Number of worker processes. Defaults to 1.
+#         log_level (str, optional): Log level for the server ('debug', 'info', etc.). Defaults to 'info'.
 #         show_available_providers (bool, optional): Print available providers on startup. Defaults to True.
+#         no_auth (bool, optional): Disable authentication (no API keys required). Defaults to False.
+#         no_rate_limit (bool, optional): Disable rate limiting (unlimited requests). Defaults to False.
 #
 #     Returns:
 #         None