Skip to main content

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

Project description

quartobot

License: MIT PyPI Docs

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

uv tool install quartobot

Or from git for the unreleased main:

uv tool install git+https://github.com/quartobot/quartobot

Documentation: quartobot.github.io/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.json 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.

Around that resolution step, quartobot ships a Python CLI:

  • resolve is the pre-render hook itself — invoked by Quarto from _quarto.yml's project.pre-render: line.
  • scan and validate are CI-lint surfaces: cite-key inventory and static _quarto.yml checks.
  • init scaffolds the citation pipeline into an existing Quarto project — the pre-render hook wiring, a seed references.bib, and a .gitignore augment. Pairs with quarto create project manuscript|book|website for new projects.
  • use github-ci layers the manuscript-as-software CI on top (.github/workflows/render.yml, the version-banner Quarto include, PR-preview cleanup). Opt-in.
  • mcp starts a stdio MCP server so an agent in Claude Desktop, Codex, or Gemini Code Assist can call the same resolver as part of a drafting workflow.

Starting a new manuscript looks like:

uv tool install quartobot
quarto create project manuscript my-paper
cd my-paper && quartobot init
# Optional: scaffold the render workflow + version banner + permalink CI.
quartobot use github-ci

quartobot deliberately does not ship its own GitHub template repo — Quarto's own quarto create project scaffolders cover the project shape, and quartobot init (plus use github-ci when wanted) layers the citation resolution and CI on top. The template/ and template-book/ directories in this repo are worked-example references, not GitHub templates.

Supported cite-key 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, CI scaffolding, and the agent-facing MCP surface.

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.

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 working reference the template is being lifted from.

See also

License

MIT.


quartobot is an independent community project. It builds on Quarto but is not affiliated with or endorsed by Posit, PBC, the makers of Quarto.

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.3.0.tar.gz (83.2 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.3.0-py3-none-any.whl (55.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for quartobot-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6031e997f4841920efeded617b990685d39d1cde04c53a04244fcf938d426012
MD5 4ce5ee2c7bf18651e2e0aa2823a8e40f
BLAKE2b-256 5903c4f04132d5126a53ca48d713750ae9227a025df5ac45fde7c0c5c29e2341

See more details on using hashes here.

Provenance

The following attestation bundles were made for quartobot-0.3.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.3.0-py3-none-any.whl.

File metadata

  • Download URL: quartobot-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 55.8 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0be1922cc8b3dcc558408e313ea7fbefff2bbc0a09305b3ce107ac2d6bec6e20
MD5 6ad6dc0421cacdd5426d80a489271bd2
BLAKE2b-256 834173882e398b9d98baef89ca2d3e88d2534bf88bc2e2e733a2d5a5a4c02ea9

See more details on using hashes here.

Provenance

The following attestation bundles were made for quartobot-0.3.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