Skip to main content

Automated retrieval, filtering, and LLM-powered summarization of arXiv papers based on your research interests.

Project description

paperweight

PyPI GitHub License Python 3.11+

paperweight is an arXiv triage CLI. It fetches recent papers, filters for relevance, and produces a digest 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

Install

pip install academic-paperweight

From source:

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
paperweight doctor
paperweight run --force-refresh

Notes:

  • init writes config.yaml with safe defaults.
  • default analyzer mode is abstract (no summarization API key required).
  • triage can run with heuristic fallback if no key is present.

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 --max-items 20

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

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

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

Detailed command behavior: docs/CLI.md

Configuration

Core sections:

  • arxiv: categories and max results
  • triage: shortlist gate (title + abstract)
  • processor: scoring config
  • analyzer: abstract or summary
  • logging
  • notifier (optional, only for email)

See: docs/CONFIGURATION.md

Roadmap

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

Development

make lint
make test

License

MIT. See LICENSE.

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

academic_paperweight-0.2.0.tar.gz (136.9 kB view details)

Uploaded Source

Built Distribution

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

academic_paperweight-0.2.0-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

Details for the file academic_paperweight-0.2.0.tar.gz.

File metadata

  • Download URL: academic_paperweight-0.2.0.tar.gz
  • Upload date:
  • Size: 136.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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}

File hashes

Hashes for academic_paperweight-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3804467ccf3aba94b9a556f90839a51b379a167fc94bb351d63b2f4293c1c555
MD5 269c9f535f051b5af012d26fe3fc7ca1
BLAKE2b-256 9c9f3338efc619b33a15f8d863042146f31552bbc49da949d2365ae6381a7275

See more details on using hashes here.

File details

Details for the file academic_paperweight-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: academic_paperweight-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","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}

File hashes

Hashes for academic_paperweight-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f746be47c143dc58e3a1bfef156aa83cfce9e2a5eb525ce7fbcdd7dd86a0aad6
MD5 5b4517cf4fe5fb91e6a807664f02d11d
BLAKE2b-256 5d23842ed11d7eb8f097a8cd6bcbba20a8babfe07e6bec539e0256c81a3beb66

See more details on using hashes here.

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