academic-refchecker 2.0.19__py3-none-any.whl → 2.0.20__py3-none-any.whl

{academic_refchecker-2.0.19.dist-info → academic_refchecker-2.0.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: academic-refchecker
-Version: 2.0.19
+Version: 2.0.20
 Summary: A comprehensive tool for validating reference accuracy in academic papers
 Author-email: Mark Russinovich <markrussinovich@hotmail.com>
 License-Expression: MIT
@@ -85,7 +85,6 @@ Validate reference accuracy in academic papers. Useful for authors checking bibl
 - [Run](#run)
 - [Output](#output)
 - [Configure](#configure)
-- [Docker](#docker)
 - [Local Database](#local-database)
 - [Testing](#testing)
 - [License](#license)
@@ -214,6 +213,69 @@ curl http://localhost:8000/
 
 Web UI documentation: see [web-ui/README.md](web-ui/README.md).
 
+### Docker
+
+Pre-built multi-architecture images are published to GitHub Container Registry on every release.
+
+#### Quick Start
+
+```bash
+docker run -p 8000:8000 ghcr.io/markrussinovich/refchecker:latest
+```
+
+Open **http://localhost:8000** in your browser.
+
+#### With LLM API Key
+
+Pass your API key for LLM-powered reference extraction (recommended):
+
+```bash
+# Anthropic Claude (recommended)
+docker run -p 8000:8000 -e ANTHROPIC_API_KEY=your_key ghcr.io/markrussinovich/refchecker:latest
+
+# OpenAI
+docker run -p 8000:8000 -e OPENAI_API_KEY=your_key ghcr.io/markrussinovich/refchecker:latest
+
+# Google Gemini
+docker run -p 8000:8000 -e GOOGLE_API_KEY=your_key ghcr.io/markrussinovich/refchecker:latest
+```
+
+#### Persistent Data
+
+Mount a volume to persist check history and settings between restarts:
+
+```bash
+docker run -p 8000:8000 \
+  -e ANTHROPIC_API_KEY=your_key \
+  -v refchecker-data:/app/data \
+  ghcr.io/markrussinovich/refchecker:latest
+```
+
+#### Docker Compose
+
+For easier configuration with an `.env` file:
+
+```bash
+git clone https://github.com/markrussinovich/refchecker.git && cd refchecker
+cp .env.example .env  # Add your API keys
+docker compose up -d
+```
+
+Common commands:
+
+```bash
+docker compose logs -f    # View logs
+docker compose down       # Stop
+docker compose pull       # Update to latest
+```
+
+#### Available Tags
+
+| Tag | Description | Arch | Size |
+|-----|-------------|------|------|
+| `latest` | Latest stable release | amd64, arm64 | ~800MB |
+| `X.Y.Z` | Specific version (e.g., `2.0.18`) | amd64, arm64 | ~800MB |
+
 ### CLI
 
 ```bash
@@ -314,29 +376,6 @@ export ANTHROPIC_API_KEY=your_key           # Also: OPENAI_API_KEY, GOOGLE_API_K
 export SEMANTIC_SCHOLAR_API_KEY=your_key    # Higher rate limits / faster verification
 ```
 
-## Docker
-
-Pre-built images are published to GitHub Container Registry.
-
-```bash
-docker run -p 8000:8000 \
-       -e ANTHROPIC_API_KEY=your_key \
-       -v refchecker-data:/app/data \
-       ghcr.io/markrussinovich/refchecker:latest
-```
-
-Docker Compose:
-
-```bash
-git clone https://github.com/markrussinovich/refchecker.git && cd refchecker
-cp .env.example .env  # Add your API keys
-docker compose up -d
-```
-
-| Tag | Description | Arch | Size |
-|-----|-------------|------|------|
-| `latest` | RefChecker (Web UI + API-based LLM support) | amd64, arm64 | ~800MB |
-
 ## Local Database
 
 For offline verification or faster processing:

{academic_refchecker-2.0.19.dist-info → academic_refchecker-2.0.20.dist-info}/RECORD

@@ -1,4 +1,4 @@
-academic_refchecker-2.0.19.dist-info/licenses/LICENSE,sha256=Kwrx3fePVCeEFDCZvCW4OuoTNBiSoYbpGBI6qzGhWF0,1067
+academic_refchecker-2.0.20.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
@@ -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=vHLK-xjo5zn4rni47JXc2jHVKcszjZka6aMOXd6sYg8,66
+refchecker/__version__.py,sha256=hTSoOjVnDINS49y55NzC61VIDB7P4FCVfqzBSgRQeFI,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.19.dist-info/METADATA,sha256=RAuuYEAPfr8Q2SU2aDvHhsBKoYYAXOxyfgBTlTDC4oc,11224
-academic_refchecker-2.0.19.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-academic_refchecker-2.0.19.dist-info/entry_points.txt,sha256=9cREsaKwlp05Ql0CBIjKrNHk5IG2cHY5LvJPsV2-SxA,108
-academic_refchecker-2.0.19.dist-info/top_level.txt,sha256=FfNvrvpj25gfpUBjW0epvz7Qrdejhups5Za_DBiSRu4,19
-academic_refchecker-2.0.19.dist-info/RECORD,,
+academic_refchecker-2.0.20.dist-info/METADATA,sha256=u1-0BA8T3zKcUw5SeoLha5XIRxwSBOYvy1usLJdevGE,12184
+academic_refchecker-2.0.20.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+academic_refchecker-2.0.20.dist-info/entry_points.txt,sha256=9cREsaKwlp05Ql0CBIjKrNHk5IG2cHY5LvJPsV2-SxA,108
+academic_refchecker-2.0.20.dist-info/top_level.txt,sha256=FfNvrvpj25gfpUBjW0epvz7Qrdejhups5Za_DBiSRu4,19
+academic_refchecker-2.0.20.dist-info/RECORD,,

refchecker/__version__.py

@@ -1,3 +1,3 @@
 """Version information for RefChecker."""
 
-__version__ = "2.0.19"
+__version__ = "2.0.20"