Skip to main content

paperweight

PyPI GitHub License Python 3.11+

paperweight is an arXiv triage CLI. It fetches recent papers, filters them against your research interests, and produces a ranked digest — optionally with LLM-powered summarization — that you can read in minutes.

Why this exists

Checking arXiv directly is great for discovery. paperweight is for a different job:

  • keep your daily list short
  • rank by your interests
  • make output scriptable (stdout, json, atom)
  • run the same way every day

How it works

arXiv API → metadata fetch → AI triage → keyword scoring → (optional) LLM summary → deliver
  1. Fetch — pull recent papers from configured arXiv categories.
  2. Triage — an LLM shortlists papers by title and abstract (or pass all through with heuristic fallback when no key is set).
  3. Score — keyword matching against titles and abstracts produces a relevance score.
  4. Summarize — in abstract mode (default) the abstract is passed through as-is; in summary mode an LLM generates a concise summary from the full paper.
  5. Deliver — output as plain text, JSON, Atom feed, or email.

Install

pip install academic-paperweight

From source (requires uv):

git clone https://github.com/seanbrar/paperweight.git
cd paperweight
uv sync --all-extras
source .venv/bin/activate

Quick start (works without API keys)

paperweight init    # create config.yaml with safe defaults
paperweight doctor  # check your setup for issues
paperweight run     # fetch papers and produce a digest

The first run automatically backfills a week of papers. After that, the same paperweight run fetches only what's new. Use --force-refresh to re-fetch if you've already run today.

Notes:

  • Default analyzer mode is abstract (no API key required).
  • Triage runs with heuristic fallback if no LLM key is present.

Example output

Running paperweight with the default config prints a plain-text digest to stdout:

paperweight digest

1. CoPE-VideoLM: Codec Primitives For Efficient Video Language Models
   Authors: Sayan Deb Sarkar, Rémi Pautrat, Ondrej Miksik +4 more
   Date: 2026-02-13
   Score: 6.24
   Matched: language model, reasoning, transformer
   Link: http://arxiv.org/abs/2602.13191v1
   Summary: Video Language Models (VideoLMs) empower AI systems to understand
   temporal dynamics in videos. To fit to the maximum context window constraint,
   current methods use keyframe sampling which can miss both macro-level events
   and micro-level details ...

2. In-Context Autonomous Network Incident Response: ...
   Authors: Yiran Gao, Kim Hammar, Tao Li
   Date: 2026-02-13
   Score: 6.24
   Matched: language model, reasoning
   Link: http://arxiv.org/abs/2602.13156v1
   Summary: Rapidly evolving cyberattacks demand incident response systems ...

Pipe to JSON for scripting, or deliver as an Atom feed or email — see CLI below.

CLI

paperweight [run-options]
paperweight run [run-options]
paperweight init [--config PATH] [--force]
paperweight doctor [--config PATH] [--strict]

Examples:

# default plain-text digest to stdout
paperweight

# JSON output for scripts
paperweight run --delivery json --output ./paperweight.json

# Atom feed output
paperweight run --delivery atom --output ./paperweight.xml

# optional email delivery (requires notifier.email config)
paperweight run --delivery email

# cap processing to 20 papers (output may be fewer after filtering)
paperweight run --max-items 20

# strict checks for CI/release gates
paperweight doctor --strict

# activate a named profile
paperweight run --profile fast

Full command reference: docs/CLI.md

Configuration

paperweight init generates a config.yaml with all required sections. Core sections:

Section Purpose
arxiv arXiv categories to watch and max results per fetch
triage LLM-powered shortlisting on title + abstract (opt-in, requires API key)
processor Keyword lists and scoring weights for relevance ranking
analyzer abstract (default, no key) or summary (LLM-generated)
concurrency Thread/worker limits for fetching, triage, and summarization
feed Metadata for --delivery atom output
metadata_cache Avoids repeated arXiv API calls within a TTL window
profiles Named config overlays activated with --profile NAME
logging Log level and optional log file path
notifier SMTP settings for --delivery email
db Optional Postgres persistence for runs and results
storage Base directory for artifact storage

Full reference: docs/CONFIGURATION.md

Secrets and environment variables

API keys and passwords can be supplied via:

  • a .env file in the project root (OPENAI_API_KEY, GEMINI_API_KEY, etc.)
  • ${VAR} interpolation in config.yaml (e.g., password: ${EMAIL_PASSWORD})
  • PAPERWEIGHT_ prefixed env vars to override any config value

See docs/ENVIRONMENT_VARIABLES.md for details.

Roadmap

See docs/ROADMAP.md for quantified release goals and forward plan.

Development

make lint        # ruff check
make typecheck   # mypy
make test        # pytest with coverage
make format      # auto-format with ruff
make all         # lint + typecheck + test

See docs/CONTRIBUTING.md for the full contributing guide.

License

MIT

Metadata

Release files for academic-paperweight 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for academic-paperweight 0.3.1
File Size Uploaded
academic_paperweight-0.3.1.tar.gz 156.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for academic-paperweight 0.3.1
File Interpreter ABI Platform
academic_paperweight-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 196.4 kB

Release files / academic_paperweight-0.3.1.tar.gz

Download URL academic_paperweight-0.3.1.tar.gz
Size 156.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f7234f053ee39955c98cc4b309038c1cc422bf0d17ded6453293ccae2c4176b4
BLAKE2b-256 checksum
How to use checksums
781d9e8a62a3a60c83c5c0ded83088381613ae1b20461678b1f784d391b6f69b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / academic_paperweight-0.3.1-py3-none-any.whl

Download URL academic_paperweight-0.3.1-py3-none-any.whl
Size 40.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
899d360550b8637a9129d87298ad8dd213c3c8ab8e48637f2137e4d906f3790f
BLAKE2b-256 checksum
How to use checksums
3b72787cf9f9b8b0101da9205bcee3894c2487201ebfd392278b825c35567bef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.3 {"installer":{"name":"uv","version":"0.10.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.3.0

2 release files

0.2.0

2 release 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