Skip to main content

A tool that generates concise summaries for you Miniflux feeds.

Project description

minigist

AI-powered summaries for your Miniflux feeds.

Turn your long Miniflux articles into clear, concise summaries.

Build status  License  PyPI 

🤘 Features

  • Automatic summarization of unread Miniflux entries
  • Configurable filters to target specific feeds
  • Notification support via Apprise for various messaging services
  • Dry-run mode to preview changes without modifying entries
  • Structured logging for better debugging and monitoring

🚀 Installation

Install minigist using pip:

pip install minigist

Install minigist using uv:

uv tool install minigist

📄 Usage

Configuration

Create a configuration file at ~/.config/minigist/config.yaml:

miniflux:
  url: "https://your-miniflux-instance.com"
  api_key: "your-miniflux-api-key"

ai:
  api_key: "your-ai-service-api-key"
  base_url: "https://openrouter.ai/api/v1"  # Default
  model: "google/gemini-2.5-flash-preview"  # Default
  system_prompt: "Generate an executive summary of the provided article."  # Default

filters:
  feed_ids: [1, 2, 3]  # Optional
  fetch_limit: 100     # Default

notifications:
  urls:                # Apprise notification URLs (optional)
    - "discord://webhook_id/webhook_token"
    - "telegram://bot_token/chat_id"

See Apprise documentation for all supported notification services.

Basic Commands

Run minigist to process unread entries:

minigist run

Run in dry-run mode to see what would happen without making changes:

minigist run --dry-run

Increase logging verbosity:

minigist run --log-level DEBUG

Use a different configuration file:

minigist run --config-file /path/to/config.yaml

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

minigist-0.2.0.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

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

minigist-0.2.0-py3-none-any.whl (13.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: minigist-0.2.0.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.2

File hashes

Hashes for minigist-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c50f53fbb400a1554c07c58d3ccfdbd8bca4c4576e6b4a22b056c9829fcf1fdd
MD5 46f59433055887e206aa2ff8d564f490
BLAKE2b-256 d610ca22d820f6514f0b058506d0abdc30a7215ad2a49b9146ba63dfa0f4b179

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minigist-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.2

File hashes

Hashes for minigist-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51c4d4a7de5e4c2f91d2610b906cc351d7bab45fb8954fc7a8caf6632536f7a0
MD5 a95018f8e21234c239700f12f1ee9c6b
BLAKE2b-256 7ae253b115c09e38264733f4fb18d21538e54f97fb6de756de01cec4722d8b71

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