miniflux-summary-agent 0.1.0

Summarize Miniflux articles with Ollama

Miniflux Summary Agent

A command-line RSS article summarization tool that fetches articles from your Miniflux RSS reader and generates concise AI-powered summaries organized by category.

Installation

Using pipx (recommended)

pipx install miniflux-summary-agent

Using uvx

uvx miniflux-summary-agent

Using pip

pip install miniflux-summary-agent

Quick Start

1. Prerequisites: Ensure you have Miniflux running and Ollama installed locally
2. Setup: Configure environment variables (see Configuration section)
3. Run:
   • miniflux-summary (if installed globally)
   • python -m miniflux-summary-agent (alternative)

Development Setup

For development setup and contribution guidelines, see the Development Guide

How It Works

The agent follows a simple workflow:

1. Fetch: Retrieves articles from your Miniflux RSS reader using the API
2. Enhance: Detects brief summaries and fetches full article content when possible, or if needed
3. Summarize: Processes each article through Ollama to generate 2-4 sentence summaries
4. Organize: Groups summaries by category and generates an HTML report

Configuration

Configure via environment variables:

• MINIFLUX_URL: Your Miniflux instance URL
• MINIFLUX_API_KEY: API key from Miniflux settings
• ARTICLE_HOURS_BACK: Hours of articles to fetch (default: 6)
• LOG_LEVEL: Logging level (default: INFO)

Requirements

• Python ≥3.10
• Miniflux RSS reader instance
• Ollama with llama3.1:8b model

License

This project is open source. Please check the repository for license details.