Skip to main content

touchneedle

PyPI Python versions Tests Licence

Verifies that the citations in a document are real, accurately described, and consistently used — including the fabricated-citation signature an AI-drafted bibliography produces: a real title carrying the wrong authors, or a plausible reference to a paper that does not exist.

Useful for students and examiners, and for anyone checking a reference list a model wrote.

It works standalone, or as a coding agent skill.

Most commercial citation checkers want a .bib file and check it against academic databases. That covers journal articles but misses standards, specifications, vendor documentation, and blog posts. In a lot of real bibliographies, this is half the list.

So this tool parses a prose reference list straight out of Markdown or .docx, in the four style families a real document uses — author-date (Harvard, APA, Chicago author-date), numeric (IEEE, Vancouver/AMA), MLA, and footnote styles (Chicago notes, MHRA) — and routes each entry to whichever authority can actually confirm it. The style is auto-detected, or forced with --style.

What it checks

Existence and metadata — scripted and deterministic:

Entry carries Checked against
arXiv id arXiv API
DOI Crossref
RFC number IETF datatracker, falling back to rfc-editor
draft-* name IETF datatracker, including whether the cited revision is still current
Quoted title in an academic venue Crossref, then OpenAlex, by title
A URL and nothing else Fetched live; page title compared with the cited title

Entries with both an identifier and a URL get both, so a real paper behind a dead link is still reported. Detects the fabricated-citation signature — a real title carrying the wrong authors — as MISMATCH.

Internal consistency — every in-text citation resolves to a list entry, every list entry is cited somewhere, and 2025a/2025b suffixes are used unambiguously. Bracket markers resolve by number, author-page citations by surname, footnote markers through their note — a shortened note or an Ibid. links to the full citation it repeats.

Claim support — the pass that needs reading rather than fetching. claims emits a worklist pairing each in-text citation with the sentence making the claim and a locator for the source; the model then reads each source and rules SUPPORTED / PARTIAL / UNSUPPORTED / INACCESSIBLE. This catches the failure the database checks cannot: a genuine source attached to a claim it does not make.

What it produces

A Markdown report, worst findings first. From the test fixture, run live:

## Entries needing attention

### STALE — IETF (2025a)

> IETF (2025a) 'The OAuth 2.1 Authorization Framework', Internet-Draft draft-ietf-oauth-v2-1-13.

- cited as -13 but the current revision is -15; an Internet-Draft is a moving
  target, so confirm the cited text survived

### NOT_FOUND — Uncited (2021)

> Uncited, A. (2021) 'A paper that nobody in this document cites', Journal of
> Irreproducible Results. doi:10.1000/uncited.

- Crossref has no record for DOI 10.1000/uncited

## Cross-reference consistency

### In-text citations with no matching reference entry

- `Nonexistent (2019)` — …An orphan citation appears here (Nonexistent, 2019).…

The full report — five entries verified against arXiv, Crossref and the IETF datatracker, one link that has quietly moved, and the cross-reference pass in both directions.

--json writes the same results machine-readably, for a CI step or a dashboard.

Install

As a command-line tool:

pip install touchneedle

As a Claude Code skill:

git clone https://github.com/nicoleman0/touchneedle ~/.claude/skills/touchneedle

Or as a Claude Code plugin:

/plugin marketplace add nicoleman0/touchneedle
/plugin install touchneedle

There are no dependencies beyond Python 3.11+. pandoc is needed only for .docx input.

Then, in Claude Code: "check the citations in thesis.docx".

Use directly

touchneedle check thesis.docx --out report.md --json data.json
touchneedle claims thesis.docx --out claims.md

From a clone, without installing, that is python3 scripts/touchneedle.py … — the same file either way.

Options: --offline (parse and cross-check only, no network), --style {auto,author-date,numeric,mla,notes} (default auto, detected from the list and the in-text markers), --cache DIR (HTTP cache, 7-day TTL, so re-runs are nearly free), --timeout N, and --mailto you@example.com for Crossref and OpenAlex's polite rate-limit pool. --mailto is off by default and never inferred — it sends an address to third parties.

check exits 2 when something needs attention, 0 when clean, so it drops into CI.

Statuses

MISMATCH and NOT_FOUND are the ones that damage a submission. LINK_DEAD and STALE need a fix but not a retraction. PARTIAL, LINK_MOVED and UNVERIFIABLE are for a glance — notably, PDFs and JS-rendered pages land in PARTIAL routinely, because no <title> can be read from them. A PARTIAL is a limit of the check, not evidence against the citation.

Limits

Page numbers, edition and publisher details are not checked.

MLA narrative citations that end in a bare page number (Smith argues the point (42)) are not matched, because a bare parenthesised number cannot be told from any other parenthesised digit. A shortened footnote note that cannot be linked to its full citation is kept as an entry with a caveat rather than silently merged.

The list of in-text citations with no matching entry has expected false positives: a regex cannot distinguish (Smith, 2024) from (ICLR 2023), or [12] from a figure reference. The report says which shape to expect per style.

Sources behind paywalls cannot be verified beyond their metadata record.

Development

python3 -m unittest discover -s tests -t tests

See CONTRIBUTING.md before opening a pull request.

The short version: standard library only, tests stay offline, and never let a coverage gap report itself as a finding.

Licence

MIT — see LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

touchneedle-0.2.1.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

touchneedle-0.2.1-py3-none-any.whl (26.8 kB view details)

Uploaded Python 3

File details

Details for the file touchneedle-0.2.1.tar.gz.

File metadata

  • Download URL: touchneedle-0.2.1.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for touchneedle-0.2.1.tar.gz
Algorithm Hash digest
SHA256 8391da027f566b99c99f282488d052df8a764b4f09e150103e1921240b932c4f
MD5 7819cb414ee935c9e9af8f7b193d89de
BLAKE2b-256 0e2990d38e39fa0d59006c726746ceccc9b55daf31ec08eed743a414050b9e73

See more details on using hashes here.

Provenance

The following attestation bundles were made for touchneedle-0.2.1.tar.gz:

Publisher: publish.yml on nicoleman0/touchneedle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file touchneedle-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: touchneedle-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 26.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for touchneedle-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f8e24d0a204aa1271fdcdba1ed863d87576b451cf1e3ca45de7e51d6120ae245
MD5 b77089d5122b45f4f034e5b9534ffbeb
BLAKE2b-256 42e4054f94d25820144256d7c6a6171cfba22d516d3efc2301c25cf813c1f923

See more details on using hashes here.

Provenance

The following attestation bundles were made for touchneedle-0.2.1-py3-none-any.whl:

Publisher: publish.yml on nicoleman0/touchneedle

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.2

2 files

This release

0.2.1 This release

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page