academic-refchecker 1.2.65__tar.gz → 1.2.67__tar.gz

{academic_refchecker-1.2.65 → academic_refchecker-1.2.67}/MANIFEST.in

@@ -10,6 +10,12 @@ recursive-include config *.conf *.py
 # Include source code
 recursive-include src *.py
 
+# Include backend code
+recursive-include backend *.py
+
+# Include web UI frontend (built assets)
+recursive-include backend/static *
+
 # Include scripts
 recursive-include scripts *.py
 
@@ -36,3 +42,9 @@ prune .claude
 exclude .gitignore
 exclude Makefile
 exclude reference_errors.txt
+
+# Exclude backend runtime files (databases, logs, uploads)
+prune backend/uploads
+exclude backend/*.db
+exclude backend/*.log
+exclude backend/.encryption_key

{academic_refchecker-1.2.65/src/academic_refchecker.egg-info → academic_refchecker-1.2.67}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: academic-refchecker
-Version: 1.2.65
+Version: 1.2.67
 Summary: A comprehensive tool for validating reference accuracy in academic papers
 Author-email: Mark Russinovich <markrussinovich@hotmail.com>
 License-Expression: MIT
@@ -57,6 +57,16 @@ Provides-Extra: vllm
 Requires-Dist: vllm>=0.3.0; extra == "vllm"
 Requires-Dist: huggingface_hub>=0.17.0; extra == "vllm"
 Requires-Dist: torch>=2.0.0; extra == "vllm"
+Provides-Extra: webui
+Requires-Dist: fastapi>=0.100.0; extra == "webui"
+Requires-Dist: uvicorn[standard]>=0.22.0; extra == "webui"
+Requires-Dist: pydantic>=2.0.0; extra == "webui"
+Requires-Dist: aiosqlite>=0.19.0; extra == "webui"
+Requires-Dist: httpx>=0.24.0; extra == "webui"
+Requires-Dist: cryptography>=42.0.0; extra == "webui"
+Requires-Dist: pymupdf>=1.23.0; extra == "webui"
+Requires-Dist: Pillow>=9.0.0; extra == "webui"
+Requires-Dist: python-multipart>=0.0.6; extra == "webui"
 Dynamic: license-file
 
 # 📚 Academic Paper Reference Checker
@@ -176,9 +186,18 @@ Learn about RefChecker's design philosophy and development process in this detai
 
 RefChecker also includes a modern web interface with real-time progress updates, check history, and export options.
 
+### Prerequisites
+
+- **Python 3.8+** with RefChecker installed (`pip install academic-refchecker[webui]`)
+- **Node.js 18+** and npm
+
 ### Quick Start (Web UI)
 
 ```bash
+# Install Python dependencies (if not already done)
+pip install academic-refchecker[llm,webui]
+
+# Install Node.js dependencies
 cd web-ui
 npm install    # First time only
 npm start      # Starts both backend and frontend
@@ -186,6 +205,20 @@ npm start      # Starts both backend and frontend
 
 Then open **http://localhost:5173** in your browser.
 
+### Alternative: Start Servers Separately
+
+**Terminal 1 - Backend:**
+```bash
+refchecker-webui --port 8000
+# Or: python -m uvicorn backend.main:app --port 8000
+```
+
+**Terminal 2 - Frontend:**
+```bash
+cd web-ui
+npm run dev
+```
+
 ### Features
 
 - ✨ Real-time validation with live progress updates
@@ -284,24 +317,33 @@ You can debug vllm server issues by running refchecker with the `--debug` flag.
 
 ## 📦 Installation
 
+### Prerequisites
+
+- **Python 3.8+** (3.10+ recommended)
+- **Node.js 18+** and npm (only required for Web UI)
+
 ### Option 1: Install from PyPI (Recommended)
 
 For the latest stable release with all features:
 
 ```bash
-pip install academic-refchecker[llm,dev,optional]
+pip install academic-refchecker[llm,webui]
 ```
 
 This installs RefChecker with:
 - **llm**: Support for OpenAI, Anthropic, Google, Azure, and vLLM providers
-- **dev**: Development tools (pytest, black, flake8, mypy)
-- **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
+- **webui**: Web interface dependencies (FastAPI, uvicorn, etc.)
 
-For a minimal installation:
+For a minimal installation (CLI only, no LLM or Web UI):
 ```bash
 pip install academic-refchecker
 ```
 
+Other optional extras:
+- **dev**: Development tools (pytest, black, flake8, mypy)
+- **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
+- **vllm**: Local model inference with vLLM
+
 ### Option 2: Install from Source
 
 #### 1. Clone the Repository
@@ -311,13 +353,27 @@ git clone https://github.com/markrussinovich/refchecker.git
 cd refchecker
 ```
 
-#### 2. Install Dependencies
+#### 2. Create and Activate Virtual Environment (Recommended)
+
+```bash
+python -m venv .venv
+# On Windows:
+.venv\Scripts\activate
+# On macOS/Linux:
+source .venv/bin/activate
+```
+
+#### 3. Install Dependencies
 
 ```bash
+# Install all dependencies including LLM and Web UI support
+pip install -e ".[llm,webui]"
+
+# Or install from requirements.txt
 pip install -r requirements.txt
 ```
 
-#### 3. (Optional) Install Additional Dependencies
+#### 4. (Optional) Install Additional Dependencies
 
 For enhanced performance and LLM support, you can install optional dependencies:
 
@@ -337,6 +393,15 @@ pip install selenium
 pip install pikepdf
 ```
 
+### Web UI Installation
+
+The Web UI requires Node.js 18+ in addition to the Python dependencies:
+
+```bash
+cd web-ui
+npm install
+```
+
 ## 📖 Usage
 
 Check papers in various formats and online locations:

{academic_refchecker-1.2.65 → academic_refchecker-1.2.67}/README.md

@@ -115,9 +115,18 @@ Learn about RefChecker's design philosophy and development process in this detai
 
 RefChecker also includes a modern web interface with real-time progress updates, check history, and export options.
 
+### Prerequisites
+
+- **Python 3.8+** with RefChecker installed (`pip install academic-refchecker[webui]`)
+- **Node.js 18+** and npm
+
 ### Quick Start (Web UI)
 
 ```bash
+# Install Python dependencies (if not already done)
+pip install academic-refchecker[llm,webui]
+
+# Install Node.js dependencies
 cd web-ui
 npm install    # First time only
 npm start      # Starts both backend and frontend
@@ -125,6 +134,20 @@ npm start      # Starts both backend and frontend
 
 Then open **http://localhost:5173** in your browser.
 
+### Alternative: Start Servers Separately
+
+**Terminal 1 - Backend:**
+```bash
+refchecker-webui --port 8000
+# Or: python -m uvicorn backend.main:app --port 8000
+```
+
+**Terminal 2 - Frontend:**
+```bash
+cd web-ui
+npm run dev
+```
+
 ### Features
 
 - ✨ Real-time validation with live progress updates
@@ -223,24 +246,33 @@ You can debug vllm server issues by running refchecker with the `--debug` flag.
 
 ## 📦 Installation
 
+### Prerequisites
+
+- **Python 3.8+** (3.10+ recommended)
+- **Node.js 18+** and npm (only required for Web UI)
+
 ### Option 1: Install from PyPI (Recommended)
 
 For the latest stable release with all features:
 
 ```bash
-pip install academic-refchecker[llm,dev,optional]
+pip install academic-refchecker[llm,webui]
 ```
 
 This installs RefChecker with:
 - **llm**: Support for OpenAI, Anthropic, Google, Azure, and vLLM providers
-- **dev**: Development tools (pytest, black, flake8, mypy)
-- **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
+- **webui**: Web interface dependencies (FastAPI, uvicorn, etc.)
 
-For a minimal installation:
+For a minimal installation (CLI only, no LLM or Web UI):
 ```bash
 pip install academic-refchecker
 ```
 
+Other optional extras:
+- **dev**: Development tools (pytest, black, flake8, mypy)
+- **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
+- **vllm**: Local model inference with vLLM
+
 ### Option 2: Install from Source
 
 #### 1. Clone the Repository
@@ -250,13 +282,27 @@ git clone https://github.com/markrussinovich/refchecker.git
 cd refchecker
 ```
 
-#### 2. Install Dependencies
+#### 2. Create and Activate Virtual Environment (Recommended)
+
+```bash
+python -m venv .venv
+# On Windows:
+.venv\Scripts\activate
+# On macOS/Linux:
+source .venv/bin/activate
+```
+
+#### 3. Install Dependencies
 
 ```bash
+# Install all dependencies including LLM and Web UI support
+pip install -e ".[llm,webui]"
+
+# Or install from requirements.txt
 pip install -r requirements.txt
 ```
 
-#### 3. (Optional) Install Additional Dependencies
+#### 4. (Optional) Install Additional Dependencies
 
 For enhanced performance and LLM support, you can install optional dependencies:
 
@@ -276,6 +322,15 @@ pip install selenium
 pip install pikepdf
 ```
 
+### Web UI Installation
+
+The Web UI requires Node.js 18+ in addition to the Python dependencies:
+
+```bash
+cd web-ui
+npm install
+```
+
 ## 📖 Usage
 
 Check papers in various formats and online locations:

{academic_refchecker-1.2.65 → academic_refchecker-1.2.67/academic_refchecker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: academic-refchecker
-Version: 1.2.65
+Version: 1.2.67
 Summary: A comprehensive tool for validating reference accuracy in academic papers
 Author-email: Mark Russinovich <markrussinovich@hotmail.com>
 License-Expression: MIT
@@ -57,6 +57,16 @@ Provides-Extra: vllm
 Requires-Dist: vllm>=0.3.0; extra == "vllm"
 Requires-Dist: huggingface_hub>=0.17.0; extra == "vllm"
 Requires-Dist: torch>=2.0.0; extra == "vllm"
+Provides-Extra: webui
+Requires-Dist: fastapi>=0.100.0; extra == "webui"
+Requires-Dist: uvicorn[standard]>=0.22.0; extra == "webui"
+Requires-Dist: pydantic>=2.0.0; extra == "webui"
+Requires-Dist: aiosqlite>=0.19.0; extra == "webui"
+Requires-Dist: httpx>=0.24.0; extra == "webui"
+Requires-Dist: cryptography>=42.0.0; extra == "webui"
+Requires-Dist: pymupdf>=1.23.0; extra == "webui"
+Requires-Dist: Pillow>=9.0.0; extra == "webui"
+Requires-Dist: python-multipart>=0.0.6; extra == "webui"
 Dynamic: license-file
 
 # 📚 Academic Paper Reference Checker
@@ -176,9 +186,18 @@ Learn about RefChecker's design philosophy and development process in this detai
 
 RefChecker also includes a modern web interface with real-time progress updates, check history, and export options.
 
+### Prerequisites
+
+- **Python 3.8+** with RefChecker installed (`pip install academic-refchecker[webui]`)
+- **Node.js 18+** and npm
+
 ### Quick Start (Web UI)
 
 ```bash
+# Install Python dependencies (if not already done)
+pip install academic-refchecker[llm,webui]
+
+# Install Node.js dependencies
 cd web-ui
 npm install    # First time only
 npm start      # Starts both backend and frontend
@@ -186,6 +205,20 @@ npm start      # Starts both backend and frontend
 
 Then open **http://localhost:5173** in your browser.
 
+### Alternative: Start Servers Separately
+
+**Terminal 1 - Backend:**
+```bash
+refchecker-webui --port 8000
+# Or: python -m uvicorn backend.main:app --port 8000
+```
+
+**Terminal 2 - Frontend:**
+```bash
+cd web-ui
+npm run dev
+```
+
 ### Features
 
 - ✨ Real-time validation with live progress updates
@@ -284,24 +317,33 @@ You can debug vllm server issues by running refchecker with the `--debug` flag.
 
 ## 📦 Installation
 
+### Prerequisites
+
+- **Python 3.8+** (3.10+ recommended)
+- **Node.js 18+** and npm (only required for Web UI)
+
 ### Option 1: Install from PyPI (Recommended)
 
 For the latest stable release with all features:
 
 ```bash
-pip install academic-refchecker[llm,dev,optional]
+pip install academic-refchecker[llm,webui]
 ```
 
 This installs RefChecker with:
 - **llm**: Support for OpenAI, Anthropic, Google, Azure, and vLLM providers
-- **dev**: Development tools (pytest, black, flake8, mypy)
-- **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
+- **webui**: Web interface dependencies (FastAPI, uvicorn, etc.)
 
-For a minimal installation:
+For a minimal installation (CLI only, no LLM or Web UI):
 ```bash
 pip install academic-refchecker
 ```
 
+Other optional extras:
+- **dev**: Development tools (pytest, black, flake8, mypy)
+- **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
+- **vllm**: Local model inference with vLLM
+
 ### Option 2: Install from Source
 
 #### 1. Clone the Repository
@@ -311,13 +353,27 @@ git clone https://github.com/markrussinovich/refchecker.git
 cd refchecker
 ```
 
-#### 2. Install Dependencies
+#### 2. Create and Activate Virtual Environment (Recommended)
+
+```bash
+python -m venv .venv
+# On Windows:
+.venv\Scripts\activate
+# On macOS/Linux:
+source .venv/bin/activate
+```
+
+#### 3. Install Dependencies
 
 ```bash
+# Install all dependencies including LLM and Web UI support
+pip install -e ".[llm,webui]"
+
+# Or install from requirements.txt
 pip install -r requirements.txt
 ```
 
-#### 3. (Optional) Install Additional Dependencies
+#### 4. (Optional) Install Additional Dependencies
 
 For enhanced performance and LLM support, you can install optional dependencies:
 
@@ -337,6 +393,15 @@ pip install selenium
 pip install pikepdf
 ```
 
+### Web UI Installation
+
+The Web UI requires Node.js 18+ in addition to the Python dependencies:
+
+```bash
+cd web-ui
+npm install
+```
+
 ## 📖 Usage
 
 Check papers in various formats and online locations:

{academic_refchecker-1.2.65/src → academic_refchecker-1.2.67}/academic_refchecker.egg-info/SOURCES.txt

@@ -3,15 +3,30 @@ MANIFEST.in
 README.md
 pyproject.toml
 requirements.txt
+academic_refchecker.egg-info/PKG-INFO
+academic_refchecker.egg-info/SOURCES.txt
+academic_refchecker.egg-info/dependency_links.txt
+academic_refchecker.egg-info/entry_points.txt
+academic_refchecker.egg-info/requires.txt
+academic_refchecker.egg-info/top_level.txt
+backend/__init__.py
+backend/__main__.py
+backend/cli.py
+backend/concurrency.py
+backend/database.py
+backend/main.py
+backend/models.py
+backend/refchecker_wrapper.py
+backend/thumbnail.py
+backend/websocket_manager.py
+backend/static/favicon.svg
+backend/static/index.html
+backend/static/vite.svg
+backend/static/assets/index-2P6L_39v.css
+backend/static/assets/index-hk21nqxR.js
 scripts/download_db.py
 scripts/run_tests.py
 scripts/start_vllm_server.py
-src/academic_refchecker.egg-info/PKG-INFO
-src/academic_refchecker.egg-info/SOURCES.txt
-src/academic_refchecker.egg-info/dependency_links.txt
-src/academic_refchecker.egg-info/entry_points.txt
-src/academic_refchecker.egg-info/requires.txt
-src/academic_refchecker.egg-info/top_level.txt
 src/refchecker/__init__.py
 src/refchecker/__main__.py
 src/refchecker/__version__.py

{academic_refchecker-1.2.65/src → academic_refchecker-1.2.67}/academic_refchecker.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 academic-refchecker = refchecker.core.refchecker:main
+refchecker-webui = backend.cli:main

{academic_refchecker-1.2.65/src → academic_refchecker-1.2.67}/academic_refchecker.egg-info/requires.txt

@@ -40,3 +40,14 @@ joblib>=1.1.0
 vllm>=0.3.0
 huggingface_hub>=0.17.0
 torch>=2.0.0
+
+[webui]
+fastapi>=0.100.0
+uvicorn[standard]>=0.22.0
+pydantic>=2.0.0
+aiosqlite>=0.19.0
+httpx>=0.24.0
+cryptography>=42.0.0
+pymupdf>=1.23.0
+Pillow>=9.0.0
+python-multipart>=0.0.6

{academic_refchecker-1.2.65/src → academic_refchecker-1.2.67}/academic_refchecker.egg-info/top_level.txt

@@ -1 +1,2 @@
+backend
 refchecker

academic_refchecker-1.2.67/backend/__init__.py

@@ -0,0 +1,21 @@
+# Backend package for RefChecker Web UI
+"""
+RefChecker Web UI Backend
+
+This package provides the FastAPI backend for the RefChecker Web UI,
+including WebSocket support for real-time progress updates.
+
+Usage:
+    # As a command line tool (after pip install):
+    refchecker-webui --host 0.0.0.0 --port 8000
+    
+    # As a Python module:
+    python -m backend --host 0.0.0.0 --port 8000
+    
+    # With uvicorn directly:
+    uvicorn backend.main:app --host 0.0.0.0 --port 8000
+"""
+
+from .main import app
+
+__all__ = ["app"]

academic_refchecker-1.2.67/backend/__main__.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+"""
+Allow running backend as a module: python -m backend
+
+This provides a clean entry point for the WebUI backend server.
+"""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()

academic_refchecker-1.2.67/backend/cli.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+"""
+CLI entry point for RefChecker Web UI backend server.
+
+This module provides the console script entry point for the refchecker-webui command.
+"""
+
+import sys
+import argparse
+from pathlib import Path
+
+
+def main():
+    """Main entry point for the refchecker-webui command."""
+    parser = argparse.ArgumentParser(
+        description="Start the RefChecker Web UI server"
+    )
+    parser.add_argument(
+        "--host", 
+        default="0.0.0.0", 
+        help="Host to bind to (default: 0.0.0.0)"
+    )
+    parser.add_argument(
+        "--port", 
+        type=int, 
+        default=8000, 
+        help="Port to listen on (default: 8000)"
+    )
+    parser.add_argument(
+        "--reload",
+        action="store_true",
+        help="Enable auto-reload for development"
+    )
+    
+    args = parser.parse_args()
+    
+    try:
+        import uvicorn
+    except ImportError:
+        print("Error: uvicorn is not installed.")
+        print("Install it with: pip install 'academic-refchecker[webui]'")
+        sys.exit(1)
+    
+    # Check if static frontend is bundled
+    static_dir = Path(__file__).parent / "static"
+    has_frontend = static_dir.exists() and (static_dir / "index.html").exists()
+    
+    print(f"Starting RefChecker Web UI on http://{args.host}:{args.port}")
+    if has_frontend:
+        print(f"Open http://localhost:{args.port} in your browser")
+    else:
+        print("Note: Frontend not bundled. Start it separately: cd web-ui && npm run dev")
+    print()
+    
+    uvicorn.run(
+        "backend.main:app",
+        host=args.host,
+        port=args.port,
+        reload=args.reload
+    )
+
+
+if __name__ == "__main__":
+    main()

academic_refchecker-1.2.67/backend/concurrency.py

@@ -0,0 +1,100 @@
+"""
+Global concurrency limiter for reference checking across all papers.
+
+This module provides a system-wide semaphore that limits the total number
+of concurrent reference checks, regardless of how many papers are being
+checked simultaneously.
+"""
+import asyncio
+from typing import Optional
+import logging
+
+logger = logging.getLogger(__name__)
+
+# Default max concurrent reference checks
+DEFAULT_MAX_CONCURRENT = 6
+
+class GlobalConcurrencyLimiter:
+    """
+    System-wide concurrency limiter for reference checks.
+    
+    Uses a semaphore to limit total concurrent operations across
+    all paper checks.
+    """
+    
+    def __init__(self, max_concurrent: int = DEFAULT_MAX_CONCURRENT):
+        self._max_concurrent = max_concurrent
+        self._semaphore = asyncio.Semaphore(max_concurrent)
+        self._active_count = 0
+        self._lock = asyncio.Lock()
+    
+    @property
+    def max_concurrent(self) -> int:
+        return self._max_concurrent
+    
+    @property
+    def active_count(self) -> int:
+        return self._active_count
+    
+    async def set_max_concurrent(self, value: int):
+        """
+        Update the max concurrent limit.
+        
+        Note: This recreates the semaphore, so it should only be called
+        when no operations are in progress, or the caller should be aware
+        that current limits may temporarily exceed the new value.
+        """
+        if value < 1:
+            value = 1
+        if value > 50:
+            value = 50
+        
+        async with self._lock:
+            old_value = self._max_concurrent
+            self._max_concurrent = value
+            self._semaphore = asyncio.Semaphore(value)
+            logger.info(f"Global concurrency limit changed from {old_value} to {value}")
+    
+    async def acquire(self):
+        """Acquire a slot in the concurrency pool."""
+        await self._semaphore.acquire()
+        async with self._lock:
+            self._active_count += 1
+            logger.debug(f"Acquired slot, active: {self._active_count}/{self._max_concurrent}")
+    
+    def release(self):
+        """Release a slot back to the concurrency pool."""
+        self._semaphore.release()
+        # Note: can't use async lock in sync context, so we do best-effort count
+        self._active_count = max(0, self._active_count - 1)
+        logger.debug(f"Released slot, active: {self._active_count}/{self._max_concurrent}")
+    
+    async def __aenter__(self):
+        await self.acquire()
+        return self
+    
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        self.release()
+        return False
+
+
+# Global singleton instance
+_limiter: Optional[GlobalConcurrencyLimiter] = None
+
+
+def get_limiter() -> GlobalConcurrencyLimiter:
+    """Get the global concurrency limiter instance."""
+    global _limiter
+    if _limiter is None:
+        _limiter = GlobalConcurrencyLimiter()
+    return _limiter
+
+
+async def init_limiter(max_concurrent: int = DEFAULT_MAX_CONCURRENT):
+    """Initialize or reinitialize the global limiter with a specific limit."""
+    global _limiter
+    if _limiter is None:
+        _limiter = GlobalConcurrencyLimiter(max_concurrent)
+    else:
+        await _limiter.set_max_concurrent(max_concurrent)
+    return _limiter