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.0-flash-lite-001"  # Default
  system_prompt: "Generate an executive summary of the provided article."  # Optional

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minigist-0.3.6.tar.gz
Algorithm Hash digest
SHA256 34a07383be376af3c71d9bbbc406733e1350b35060e67522c7608adafd13ac98
MD5 213ec1169ca1f94a453e6a30e333a1f9
BLAKE2b-256 0a7d67dccf85fccc0e3c6f7c585f2ef6976048a8442bafdea28d1f7702bbcacc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for minigist-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 50db2ca7acc625cc1c09ba3bb57f693e03faa98fc659311c89d27786f941613c
MD5 3301a96c143e2b9ef31c3fb3ded71f24
BLAKE2b-256 86a268b219cec1ca2b795550e14bddda84ff2661560912f3a117c73927a5f681

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