Skip to main content

Citation resolution and manuscript-as-software CI for Quarto.

Project description

quartobot

Citation resolution and manuscript-as-software CI for Quarto.
Paste a DOI in your prose. Render the manuscript. The bibliography is already correct.

PyPI Python versions PyPI downloads License: MIT Docs

Tests Pre-render hook end-to-end Docs link check Ruff

quartobot demo: scan, resolve, references.json, quarto render, formatted citation in the rendered manuscript


uv tool install quartobot

Documentation: seandavi.github.io/quartobot · Source: seandavi/quartobot · PyPI: quartobot

What it does

Authors write persistent-identifier cite keys directly in prose:

We follow @doi:10.1371/journal.pcbi.1007128, with the dataset described
in @pmid:31479462 and methods inspired by @arxiv:2104.10729.

A Quarto project.pre-render: hook resolves each key to canonical metadata before pandoc-citeproc runs, writes the result to a references.resolved.bib (BibLaTeX) you can commit, and the manuscript renders the same way on every machine. No quartobot install needed at render time, no live Crossref / PubMed / arXiv hit per render. CI gets the same behavior the author saw locally, and a network blip mid-render is no longer a build failure.

Supported prefixes: @doi:, @pmid:, @arxiv:, @isbn:, @url:, @wikidata:, @pmc:, plus hand-curated keys from a project .bib. Resolution goes through manubot's citekey_to_csl_item — eight years of accumulated source-API quirks behind a single function call. quartobot itself doesn't reimplement resolution; it provides the Quarto integration, the CI scaffolding, and an agent-facing MCP surface.

Quick start

uv tool install quartobot
quarto create project manuscript my-paper
cd my-paper && quartobot init
# Optional: scaffold render + PR-preview CI.
quartobot use github-ci

That's the canonical path. Three other on-ramps live in Choose a path in for "I have an existing Quarto project" and the resolver-only minimum.

The CLI

Command What it does
resolve The pre-render hook. Invoked by Quarto from _quarto.yml's project.pre-render: line. Reads cite keys, writes BibLaTeX (references.resolved.bib) plus a CSL JSON cache.
scan / validate CI-lint surfaces. Cite-key inventory and static _quarto.yml checks.
init Scaffolds the citation pipeline into an existing Quarto project. Three files only.
use github-ci Layers the render + PR-preview CI on top. Lean default; --with-versioned-snapshots for the manubot per-commit-permalink pattern.
reconcile Resolves references.bib ↔ resolved-bibliography citation-key collisions with explicit modes. Backup-then-mutate.
versions Generates the /versions/ page on gh-pages — tagged releases + open PR previews.
mcp Stdio MCP server. Agents in Claude Desktop, Codex, Gemini Code Assist call the same resolver as part of drafting.

Full reference: CLI and Workflows and actions.

Why this exists

manubot/manubot#332 ("Quarto integration") was opened by Anthony Gitter in April 2022 after a conversation with Sean Davis. Four years on, no PR, no assignee — but Quarto Manuscripts shipped as a first-party project type, and the integration turned out to be small once the resolver question was settled. This repo is the work to close that issue.

The longer story: Differences from manubot, Design, Citation pipeline.

Working example

seandavi/2026-venice-spatial-hackathon-manuscript runs the CI / permalink / banner half of the pattern on a live 25-author preprint from the Bioconductor Spatial Hackathon. That's the production reference the template lifted from.

See also

Demo recording

The GIF above walks quartobot scanquartobot resolve (live registrar lookups) → quarto render --to html → the formatted citation in the rendered manuscript. Recorded with asciinema (cast) + agg (cast → GIF). To re-record after changing the demo flow:

brew install asciinema agg
bash scripts/demo-setup.sh
asciinema rec docs/demo.cast --command 'bash scripts/demo.sh' --overwrite
agg docs/demo.cast docs/demo.gif --font-size 18 --theme dracula --speed 1.2 --cols 80 --rows 28
cp docs/demo.gif site/public/demo.gif  # also serves the landing-page embed

The scripts/demo.tape file is a vhs alternative for a higher-fidelity render once a Chrome/Chromium environment is available.

License

MIT.


Maintained by Sean Davis.
quartobot is an independent community project. It builds on Quarto but is not affiliated with or endorsed by Posit, PBC.

Project details


Download files

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

Source Distribution

quartobot-0.5.0.tar.gz (87.9 kB view details)

Uploaded Source

Built Distribution

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

quartobot-0.5.0-py3-none-any.whl (59.0 kB view details)

Uploaded Python 3

File details

Details for the file quartobot-0.5.0.tar.gz.

File metadata

  • Download URL: quartobot-0.5.0.tar.gz
  • Upload date:
  • Size: 87.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for quartobot-0.5.0.tar.gz
Algorithm Hash digest
SHA256 139fb7d3de208719a189295b5469c2d27c0b60ae5505a6819832d258c6b83cbf
MD5 4bafa6acda430aa72ec2dd99b0a0e292
BLAKE2b-256 0ce13d7a1491ee65c44b9cc53e783fbc089406eec430841fe4f5399086da49b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for quartobot-0.5.0.tar.gz:

Publisher: publish-pypi.yml on seandavi/quartobot

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

File details

Details for the file quartobot-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: quartobot-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 59.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for quartobot-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b480146c4fc993f43e3ff26d2af56cc01ddfad6d8ebca7a593ea5b4df86ed2a
MD5 9e85e0e2af75748b7997acb0cd364c9a
BLAKE2b-256 2b8b3cf7c9b8e20b86a7bd35f8a3792804ca74027986f32a13a7c0529e0f8be4

See more details on using hashes here.

Provenance

The following attestation bundles were made for quartobot-0.5.0-py3-none-any.whl:

Publisher: publish-pypi.yml on seandavi/quartobot

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page