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.3.3.tar.gz (19.6 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.3.3-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minigist-0.3.3.tar.gz
Algorithm Hash digest
SHA256 4fc4f1fb00603c515bd594c9f6e6cd4e85386de84dc42d1434654d9bc3084508
MD5 a1145a9e7f73f7a634d749d4676dff2c
BLAKE2b-256 849db32f55d168ccc73afd195370d6ec43257b5d2dcad99a5aad46f4abe7806e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for minigist-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e0c5bc641de0c89e7063d41ef675f9c657eaf8b474881e29cdcf6909ef1261b9
MD5 9f16105b0aeb5172dff1c36f29881c51
BLAKE2b-256 fdc06ff6d34abe234eee2c6af3e6c1a559751ba939b2e33e5ddeb142a613ab6f

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