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.8.tar.gz (14.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.2.8-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minigist-0.2.8.tar.gz
Algorithm Hash digest
SHA256 f4fb54d4ee64ae9d617e0113df98ae622b0b1b17abd18c8adda7d1a6c7152041
MD5 ae0ee8bc15e2bcb05e3f4822f8321314
BLAKE2b-256 29cc36ba21049d08b41d34e485dab75b388728260b292a1336e0e73bcb1e3f53

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for minigist-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 091ffb7efe851864b3d88da46d5f976598bfebb4dcbac43b8d24fbe12af8836b
MD5 fe0d891591560f3fde8855691b474f99
BLAKE2b-256 bf27e666d345e7088bb699078a1b7dcf1c8a83129b5be6244b623a7de7c9a8b1

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