Paper Firehose Documentation

Paper Firehose filters, ranks, and summarizes research-paper RSS feeds. The project ships both a Click-based CLI and Python APIs for running the individual pipeline steps. These docs cover configuration concepts, operational workflows, and the module-level API reference.

Contents

• Usage Guide
  • Installation
  • Runtime Data Directory
  • Command Line Interface
  • Programmatic Entry Points
• GitHub Actions setup
  • Prepare your configuration
  • Bootstrap the same config locally
  • Wire up secrets
  • Set the schedule
• API Reference
  • paper_firehose
  • paper_firehose.cli
  • paper_firehose.commands.abstracts
  • paper_firehose.commands.email_list
  • paper_firehose.commands.filter
  • paper_firehose.commands.generate_html
  • paper_firehose.commands.pqa_summary
  • paper_firehose.commands.rank
  • paper_firehose.core.config
  • paper_firehose.core.database
  • paper_firehose.processors.emailer
  • paper_firehose.processors.feed_processor
  • paper_firehose.processors.html_generator
  • paper_firehose.processors.st_ranker