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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minigist-0.2.5.tar.gz
Algorithm Hash digest
SHA256 e149c4ebcf3240393dfa1e94fbc49756f9ff27b5f7e2ba22484a678a687fc08f
MD5 47947771a70e8592f9d623f6cacf827f
BLAKE2b-256 375d3b9162e61429e1916c82ed7b146d075f1139ee85e45599c0581a055de465

See more details on using hashes here.

File details

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

File metadata

  • Download URL: minigist-0.2.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 52b84451b903e73fcac35ed17d13b92b8cc5813c8804606938f72da91ae8514f
MD5 2e3daa78682b76c57af1f990e6c596a4
BLAKE2b-256 643b70c72cdb38483c79ce8c21201d4049ed0a724c148d7bd0bb9c62df7380f5

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