Skip to content

Commit aef57ad

Browse files
mkassafclaude
andcommitted
v0.3.8: README clarify optional keys, fix S2 API key URL
- Both SEMANTIC_SCHOLAR_API_KEY and GOOGLE_BOOKS_API_KEY are clearly marked as optional; tool works without them (anonymous rate limits apply) - Fix Semantic Scholar API key URL to semanticscholar.org/product/api#api-key - Improve env var table to show *(optional)* instead of bare dash Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 4e457c6 commit aef57ad

3 files changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -214,27 +214,29 @@ asyncio.run(main())
214214

215215
## Environment variables
216216

217+
All API keys are **optional** — CiteSentry works without any keys but will hit anonymous rate limits faster when checking large reference lists.
218+
217219
| Variable | Default | Description |
218220
|---|---|---|
219221
| `CITESENTRY_MAILTO` | `citesentry@example.com` | Polite email for OpenAlex/Crossref API (strongly recommended) |
220-
| `SEMANTIC_SCHOLAR_API_KEY` | | Free key from [semanticscholar.org/product/api](https://www.semanticscholar.org/product/api) — raises rate limit from ~1 req/s to 100 req/5s |
221-
| `GOOGLE_BOOKS_API_KEY` | | Free key from [Google Cloud Console](https://console.cloud.google.com) — raises limit from ~1k/day to 100k/day; used for textbook lookup |
222-
| `CITESENTRY_GROBID_URL` | `https://kermitt2-grobid.hf.space/api` | GROBID REST endpoint for high-quality PDF parsing; use `http://localhost:8070/api` for a local Docker instance |
223-
| `DEEPSEEK_API_KEY` | | Required for relevance checks in CLI (`--no-llm` skips this) |
222+
| `SEMANTIC_SCHOLAR_API_KEY` | *(optional)* | Raises Semantic Scholar rate limit from ~1 req/s to 100 req/5s — see below |
223+
| `GOOGLE_BOOKS_API_KEY` | *(optional)* | Raises Google Books limit from ~1k req/day to 100k/day; used for textbook lookup |
224+
| `CITESENTRY_GROBID_URL` | *(optional)* | GROBID REST endpoint for high-quality PDF parsing; use `http://localhost:8070/api` for a local Docker instance |
225+
| `DEEPSEEK_API_KEY` | *(optional)* | Enables relevance checks in CLI; without it `--no-llm` is effectively applied |
224226
| `DEEPSEEK_BASE_URL` | `https://api.deepseek.com/v1` | OpenAI-compatible endpoint |
225227
| `DEEPSEEK_MODEL` | `deepseek-chat` | Model for relevance judgments |
226228

227229
### Getting free API keys
228230

229-
**Semantic Scholar** (recommended — greatly improves reliability):
230-
1. Go to [semanticscholar.org/product/api](https://www.semanticscholar.org/product/api)
231-
2. Click "Get API Key" — free, instant approval
232-
3. Set `SEMANTIC_SCHOLAR_API_KEY=your_key`
231+
**Semantic Scholar** (recommended — significantly improves reliability for large reference lists):
232+
1. Go to **[semanticscholar.org/product/api#api-key](https://www.semanticscholar.org/product/api#api-key)**
233+
2. Fill in the form — free, approved within minutes
234+
3. Add to your shell profile: `export SEMANTIC_SCHOLAR_API_KEY=your_key`
233235

234-
**Google Books** (recommended for papers citing textbooks):
236+
**Google Books** (recommended when references include textbooks):
235237
1. Go to [console.cloud.google.com](https://console.cloud.google.com)
236-
2. Enable the Books API, create an API key
237-
3. Set `GOOGLE_BOOKS_API_KEY=your_key`
238+
2. Enable the "Books API" and create an API key
239+
3. Add to your shell profile: `export GOOGLE_BOOKS_API_KEY=your_key`
238240

239241
## Supported input formats
240242

citesentry/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""citesentry — citation verification tool."""
22

3-
__version__ = "0.3.7"
3+
__version__ = "0.3.8"

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "citesentry"
7-
version = "0.3.7"
7+
version = "0.3.8"
88
description = "Citation verification tool: existence, URL liveness, and content relevance checks"
99
readme = "README.md"
1010
requires-python = ">=3.10"

0 commit comments

Comments
 (0)