Metadata-Version: 2.4
Name: miniflux-summary-agent
Version: 0.1.0
Summary: Summarize Miniflux articles with Ollama
Author-email: trly <travis.lyons@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/trly/miniflux-summary-agent
Project-URL: Issues, https://github.com/trly/miniflux-summary-agent/issues
Keywords: rss,miniflux,ollama,summarization,ai,news
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4>=4.13.4
Requires-Dist: python-dotenv>=0.19.0
Requires-Dist: jinja2>=3.1.6
Requires-Dist: miniflux>=1.1.4
Requires-Dist: ollama>=0.5.1
Requires-Dist: playwright>=1.53.0
Requires-Dist: pydantic>=2.0.0
Requires-Dist: requests>=2.32.4
Requires-Dist: httpx>=0.28.1
Provides-Extra: dev
Requires-Dist: pytest>=8.4.1; extra == "dev"
Requires-Dist: pytest-asyncio>=1.1.0; extra == "dev"
Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
Requires-Dist: ruff>=0.12.4; extra == "dev"
Dynamic: license-file

# Miniflux Summary Agent

A command-line RSS article summarization tool that fetches articles from your [Miniflux](https://miniflux.app/) RSS reader and generates concise AI-powered summaries organized by category.

## Installation

### Using pipx (recommended)
```bash
pipx install miniflux-summary-agent
```

### Using uvx
```bash
uvx miniflux-summary-agent
```

### Using pip
```bash
pip install miniflux-summary-agent
```

## Quick Start

1. **Prerequisites**: Ensure you have [Miniflux](https://miniflux.app/) running and [Ollama](https://ollama.com/) 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](https://github.com/trly/miniflux-summary-agent/blob/main/DEVELOPMENT.md)

## 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
5. **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](https://miniflux.app/) RSS reader instance
- [Ollama](https://ollama.com/) with [llama3.1:8b](https://ollama.com/library/llama3.1:8b) model

## License

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