academic-refchecker 2.0.16__py3-none-any.whl → 2.0.18__py3-none-any.whl

{academic_refchecker-2.0.16.dist-info → academic_refchecker-2.0.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: academic-refchecker
-Version: 2.0.16
+Version: 2.0.18
 Summary: A comprehensive tool for validating reference accuracy in academic papers
 Author-email: Mark Russinovich <markrussinovich@hotmail.com>
 License-Expression: MIT
@@ -140,6 +140,7 @@ Learn about RefChecker's design philosophy and development process in this detai
 - [📊 Sample Output](#-sample-output)
 - [🎯 Features](#-features)
 - [🚀 Quick Start](#-quick-start)
+- [🐳 Docker (Recommended)](#-docker-recommended)
 - [🌐 Web UI](#-web-ui)
 - [🤖 LLM-Enhanced Reference Extraction](#-llm-enhanced-reference-extraction)
 - [📦 Installation](#-installation)
@@ -164,7 +165,15 @@ Learn about RefChecker's design philosophy and development process in this detai
 
 ## 🚀 Quick Start
 
-### Check Your First Paper
+### Easiest: Use Docker
+
+```bash
+docker run -p 8000:8000 -e ANTHROPIC_API_KEY=your_key ghcr.io/markrussinovich/refchecker:latest
+```
+
+Open **http://localhost:8000** in your browser. See [Docker](#-docker-recommended) for more options.
+
+### Command Line (requires Python installation)
 
 1. **Check a famous paper:**
    ```bash
@@ -183,15 +192,139 @@ Learn about RefChecker's design philosophy and development process in this detai
 
 > **⚡ Performance Tip**: Reference verification takes 5-10 seconds per reference without a Semantic Scholar API key due to rate limiting. With an API key, verification speeds up to 1-2 seconds per reference. Set `SEMANTIC_SCHOLAR_API_KEY` environment variable or use `--semantic-scholar-api-key` for faster processing.
 
+## 🐳 Docker (Recommended)
+
+The easiest way to run RefChecker is with Docker. Pre-built images are automatically published to GitHub Container Registry on every release.
+
+### Quick Start
+
+```bash
+# Pull and run the latest image (works on Intel/AMD and Apple Silicon)
+docker run -p 8000:8000 ghcr.io/markrussinovich/refchecker:latest
+```
+
+Open **http://localhost:8000** in your browser.
+
+### With LLM API Keys
+
+To use LLM-powered reference extraction (recommended for best accuracy), pass your API key:
+
+```bash
+# Using Anthropic Claude (recommended)
+docker run -p 8000:8000 \
+  -e ANTHROPIC_API_KEY=your_key_here \
+  ghcr.io/markrussinovich/refchecker:latest
+
+# Using OpenAI
+docker run -p 8000:8000 \
+  -e OPENAI_API_KEY=your_key_here \
+  ghcr.io/markrussinovich/refchecker:latest
+
+# Using Google Gemini
+docker run -p 8000:8000 \
+  -e GOOGLE_API_KEY=your_key_here \
+  ghcr.io/markrussinovich/refchecker:latest
+```
+
+### Persistent Data
+
+To persist check history and settings between container restarts:
+
+```bash
+docker run -p 8000:8000 \
+  -v refchecker-data:/app/data \
+  -e ANTHROPIC_API_KEY=your_key_here \
+  ghcr.io/markrussinovich/refchecker:latest
+```
+
+### Using Docker Compose
+
+For easier configuration, clone the repo and use the included `docker-compose.yml`:
+
+```bash
+git clone https://github.com/markrussinovich/refchecker.git
+cd refchecker
+
+# Copy the example environment file and add your API keys
+cp .env.example .env
+# Edit .env with your API keys
+
+# Start RefChecker
+docker compose up
+
+# Or run in background
+docker compose up -d
+```
+
+### GPU Support for Local Models
+
+For running local LLMs with vLLM (no API keys needed), use the GPU-enabled image:
+
+```bash
+# Pull the GPU image (amd64/NVIDIA only)
+docker pull ghcr.io/markrussinovich/refchecker:gpu
+
+# Run with GPU access
+docker run --gpus all -p 8000:8000 \
+  -v refchecker-data:/app/data \
+  -v refchecker-models:/app/models \
+  ghcr.io/markrussinovich/refchecker:gpu
+```
+
+Or with Docker Compose:
+
+```bash
+# Start with GPU profile
+docker compose --profile gpu up
+```
+
+### Available Image Tags
+
+| Tag | Description | Architectures | Size |
+|-----|-------------|---------------|------|
+| `latest` | Latest stable release with cloud LLM support | amd64, arm64 | ~800MB |
+| `X.Y.Z` | Specific version (e.g., `1.2.50`) | amd64, arm64 | ~800MB |
+| `gpu` | GPU-enabled with vLLM/PyTorch for local models | amd64 only | ~12GB |
+| `X.Y.Z-gpu` | Specific GPU version | amd64 only | ~12GB |
+
+> **Note**: The `gpu` images are amd64 only because CUDA is not available on ARM. For Apple Silicon Macs, use the standard `latest` tag with cloud LLM APIs.
+
+### Building Locally
+
+```bash
+# Build standard image
+make docker-build
+
+# Build GPU image  
+make docker-build-gpu
+
+# Run locally
+make docker-run
+
+# Test the build
+make docker-test
+```
+
 ## 🌐 Web UI
 
-RefChecker also includes a modern web interface with real-time progress updates, check history, and export options.
+RefChecker includes a modern web interface with real-time progress updates, check history, and export options.
 
 ![RefChecker Web UI](assets/webui.png)
 
-### Option 1: Install from PyPI (Recommended)
+### Features
+
+- ✨ Real-time validation with live progress updates
+- 📄 Support for ArXiv URLs and file uploads (PDF, LaTeX, text)
+- 📊 Live statistics with filtering by status
+- 📋 Export references as Markdown, plain text, or BibTeX (with corrected values)
+- 📚 Persistent check history
+- 🌓 Automatic dark/light mode
+
+### Option 1: Docker (See Above)
+
+The Docker image includes the complete Web UI - just run the container and open http://localhost:8000.
 
-The simplest way to run the Web UI is using the pip-installed package:
+### Option 2: Install from PyPI
 
 ```bash
 # Install RefChecker with Web UI support
@@ -203,15 +336,13 @@ refchecker-webui
 
 Then open **http://localhost:8000** in your browser.
 
-The `refchecker-webui` command starts a complete web server with both the API backend and the pre-built frontend.
-
 **Options:**
 ```bash
 refchecker-webui --port 8080      # Use a different port
 refchecker-webui --host 0.0.0.0   # Allow external connections
 ```
 
-### Option 2: Run from Cloned Repository (Development)
+### Option 3: Run from Cloned Repository (Development)
 
 If you're developing or modifying the Web UI:
 
@@ -248,15 +379,6 @@ cd web-ui
 npm run dev
 ```
 
-### Features
-
-- ✨ Real-time validation with live progress updates
-- 📄 Support for ArXiv URLs and file uploads (PDF, LaTeX, text)
-- 📊 Live statistics with filtering by status
-- 📋 Export references as Markdown, plain text, or BibTeX (with corrected values)
-- 📚 Persistent check history
-- 🌓 Automatic dark/light mode
-
 For complete Web UI documentation, see **[web-ui/README.md](web-ui/README.md)**.
 
 ## 🤖 LLM-Enhanced Reference Extraction
@@ -350,12 +472,20 @@ You can debug vllm server issues by running refchecker with the `--debug` flag.
 
 ## 📦 Installation
 
-### Prerequisites
+### Option 1: Docker (Recommended)
 
-- **Python 3.8+** (3.10+ recommended)
-- **Node.js 18+** and npm (only required for Web UI)
+No installation required - just run the Docker image:
 
-### Option 1: Install from PyPI (Recommended)
+```bash
+docker run -p 8000:8000 ghcr.io/markrussinovich/refchecker:latest
+```
+
+See [Docker](#-docker-recommended) section for full details on configuration, persistent data, and GPU support.
+
+### Option 2: Install from PyPI
+
+**Prerequisites:**
+- **Python 3.8+** (3.10+ recommended)
 
 For the latest stable release with all features:
 
@@ -377,7 +507,11 @@ Other optional extras:
 - **optional**: Enhanced features (lxml, selenium, pikepdf, nltk, scikit-learn)
 - **vllm**: Local model inference with vLLM
 
-### Option 2: Install from Source
+### Option 3: Install from Source
+
+**Prerequisites:**
+- **Python 3.8+** (3.10+ recommended)
+- **Node.js 18+** and npm (only required for Web UI development)
 
 #### 1. Clone the Repository
 

{academic_refchecker-2.0.16.dist-info → academic_refchecker-2.0.18.dist-info}/RECORD

@@ -1,9 +1,9 @@
-academic_refchecker-2.0.16.dist-info/licenses/LICENSE,sha256=Kwrx3fePVCeEFDCZvCW4OuoTNBiSoYbpGBI6qzGhWF0,1067
+academic_refchecker-2.0.18.dist-info/licenses/LICENSE,sha256=Kwrx3fePVCeEFDCZvCW4OuoTNBiSoYbpGBI6qzGhWF0,1067
 backend/__init__.py,sha256=TFVkOx5tSp3abty15RzUbaSwQ9ZD0kfUn7PDh63xkYY,521
 backend/__main__.py,sha256=74V7yUMsRSZaaRyXYm-rZVc3TVUcUgwsoTQTUbV5EqM,211
 backend/cli.py,sha256=xV3l9M5OdNQQYOcrzj2d_7RmCgj7CXP_1oi0TPe6zNo,1672
 backend/concurrency.py,sha256=2KY9I_8dDkyl_HTGx27ZxU4rFXx2vqbGOlo5RrRbPjA,3223
-backend/database.py,sha256=1jLP1m9vNk5sEs4bh_xmX0T5ilZkUTX1c7nOVz5XnNc,30681
+backend/database.py,sha256=mMDXdkoEutNI9jLNgqyUbwAQxVdgG0scoAubXhbPWK4,31067
 backend/main.py,sha256=Vh_hbLAGYZzitwXAZFRiU68S25ySGPmNGepQo2qwzfQ,56298
 backend/models.py,sha256=El2F-RTHgxQ7-WODmiYCpjsTFDpjwF9PBt-JDa_XipE,2591
 backend/refchecker_wrapper.py,sha256=VSQkfsMGul2bj0S7BqvhqlyuQwWykYK6fHkRKVoVFw4,55313
@@ -19,7 +19,7 @@ backend/static/assets/index-DMZJNrR0.js,sha256=UhK5CQ8IufZmx6FTvXUCtkRxTqpGK7czS
 backend/static/assets/index-hk21nqxR.js,sha256=z2agP8ZFYw4AfYi-GJ5E_8_k-lPF-frXOJtPk-I0hDs,369533
 refchecker/__init__.py,sha256=Pg5MrtLxDBRcNYcI02N-bv3tzURVd1S3nQ8IyF7Zw7E,322
 refchecker/__main__.py,sha256=agBbT9iKN0g2xXtRNCoh29Nr7z2n5vU-r0MCVJKi4tI,232
-refchecker/__version__.py,sha256=26H6z4t4GMLlqIinf2txa-9ebt2c1ncdGIlLLusiaKA,66
+refchecker/__version__.py,sha256=Xv9iRZBORGbLDjCyUAxBF30FP9L_w8z2drgb3UdJVXI,66
 refchecker/checkers/__init__.py,sha256=-dR7HX0bfPq9YMXrnODoYbfNWFLqu706xoVsUdWHYRI,611
 refchecker/checkers/arxiv_citation.py,sha256=j_waQmQSP3iuZdVuBE92ghtiOdGFTCx09s6f4mHik6o,27777
 refchecker/checkers/crossref.py,sha256=88moAyTudBqf9SKqTQkNAq1yyuRe95f8r4EpmJznupQ,20937
@@ -62,8 +62,8 @@ refchecker/utils/mock_objects.py,sha256=QxU-UXyHSY27IZYN8Sb8ei0JtNkpGSdMXoErrRLH
 refchecker/utils/text_utils.py,sha256=Tx1k0SqS1cmw4N9BDJY-Ipep2T-HMmKPqi4SMcq1ZJ8,235751
 refchecker/utils/unicode_utils.py,sha256=-WBKarXO756p7fd7gCeNsMag4ztDNURwFX5IVniOtwY,10366
 refchecker/utils/url_utils.py,sha256=7b0rWCQJSajzqOvD7ghsBZPejiq6mUIz6SGhvU_WGDs,9441
-academic_refchecker-2.0.16.dist-info/METADATA,sha256=sxE1gVhJkFMEVu8Z8OKz4nhzi8K4LI4hqGTBI525F8g,26611
-academic_refchecker-2.0.16.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-academic_refchecker-2.0.16.dist-info/entry_points.txt,sha256=9cREsaKwlp05Ql0CBIjKrNHk5IG2cHY5LvJPsV2-SxA,108
-academic_refchecker-2.0.16.dist-info/top_level.txt,sha256=FfNvrvpj25gfpUBjW0epvz7Qrdejhups5Za_DBiSRu4,19
-academic_refchecker-2.0.16.dist-info/RECORD,,
+academic_refchecker-2.0.18.dist-info/METADATA,sha256=QdH4y4-bDSXrM2Ah6UiYB97losRkX8PKG5d454M0icQ,29987
+academic_refchecker-2.0.18.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+academic_refchecker-2.0.18.dist-info/entry_points.txt,sha256=9cREsaKwlp05Ql0CBIjKrNHk5IG2cHY5LvJPsV2-SxA,108
+academic_refchecker-2.0.18.dist-info/top_level.txt,sha256=FfNvrvpj25gfpUBjW0epvz7Qrdejhups5Za_DBiSRu4,19
+academic_refchecker-2.0.18.dist-info/RECORD,,

backend/database.py

@@ -14,10 +14,20 @@ from cryptography.fernet import Fernet
 def get_data_dir() -> Path:
     """Get platform-appropriate user data directory for refchecker.
     
+    If REFCHECKER_DATA_DIR environment variable is set, use that path.
+    Otherwise, use platform-specific defaults:
+    
     Windows: %LOCALAPPDATA%\refchecker
     macOS: ~/Library/Application Support/refchecker
     Linux: ~/.local/share/refchecker
     """
+    # Check for environment variable override (useful for Docker)
+    env_data_dir = os.environ.get("REFCHECKER_DATA_DIR")
+    if env_data_dir:
+        data_dir = Path(env_data_dir)
+        data_dir.mkdir(parents=True, exist_ok=True)
+        return data_dir
+    
     if sys.platform == "win32":
         # Windows: use LOCALAPPDATA
         base = Path(os.environ.get("LOCALAPPDATA", Path.home() / "AppData" / "Local"))

refchecker/__version__.py

@@ -1,3 +1,3 @@
 """Version information for RefChecker."""
 
-__version__ = "2.0.16"
+__version__ = "2.0.18"