API ReferenceΒΆ

The API is organized around a small set of command modules and supporting classes. The sections below are generated automatically from the source annotations and docstrings.

paper_firehose

paper_firehose.cli

Command-line entry point for Paper Firehose.

paper_firehose.commands.abstracts

Fetch abstracts and populate both papers.db (entries.abstract) and matched_entries_history.db (matched_entries.abstract).

paper_firehose.commands.email_list

Email list command: generate HTML digest from papers.db and send via SMTP.

paper_firehose.commands.filter

Filter command implementation.

paper_firehose.commands.generate_html

Generate topic HTML directly from the current-run database (papers.db).

paper_firehose.commands.pqa_summary

Paper-QA Summarizer

paper_firehose.commands.rank

Rank command: compute and write rank scores into papers.db (rank_score).

paper_firehose.core.config

Configuration management for YAML-based config files.

paper_firehose.core.database

Database management for the three-database approach: - all_feed_entries.db: All RSS entries for deduplication - matched_entries_history.db: Historical matches across all topics - papers.db: Current run processing data

paper_firehose.processors.emailer

Email rendering and sending utilities for Paper Firehose.

paper_firehose.processors.feed_processor

RSS feed processing functionality.

paper_firehose.processors.html_generator

HTML output generation for filtered articles.

paper_firehose.processors.st_ranker

Sentence-Transformers based ranking processor.