Skip to main content

minigist

AI-powered summaries for your Miniflux feeds.

Turn your long Miniflux articles into clear, concise summaries.

Build status  License  PyPI 

✨ Why minigist?

Long-form feed entries are great for depth but hard to keep up with. Miniflux shows the full content, and without a summary layer you still have to read everything to decide what matters.

minigist solves this by generating concise summaries on the server side and writing them directly into each unread entry. This works with your current way to read Miniflux entries, no client changes needed.

🧠 How it works

  • You define prompts and targets in a YAML config file
  • minigist fetches the full text of unread entries (using pure.md if configured)
  • Your configured LLM generates summaries using your prompts
  • Summaries are written back into the Miniflux entry

🚀 Installation

Install minigist using pip:

pip install minigist

Install minigist using uv:

uv tool install minigist

📄 Usage

Configuration

Find below an example config file. By default, minigist searches for a config file in this order:

  • ~/.config/minigist/config.yaml
  • ~/.config/minigist/config.yml
  • ./config.yaml
  • ./config.yml
  • /etc/minigist/config.yaml
  • /etc/minigist/config.yml

You can override the path with the --config-file flag.

For credentials, you can set environment variables to override the YAML values:

  • MINIGIST_MINIFLUX_API_KEY → miniflux.api_key
  • MINIGIST_LLM_API_KEY → llm.api_key
miniflux:
  # Base URL of your Miniflux instance (required)
  url: "https://your-miniflux-instance.com"
  # Miniflux API key (required)
  api_key: "your-miniflux-api-key"
  # Request timeout in seconds (optional; default: 2)
  timeout_seconds: 2
  # What to do with feeds that Miniflux rewrites on refresh: "disable", "skip", or "allow"
  # (optional; default: "disable" with targets, "allow" without). See "Keeping summaries".
  entry_updates: "disable"

llm:
  # API key for your LLM provider (required)
  api_key: "your-ai-service-api-key"
  # API base URL (optional; default: OpenRouter)
  base_url: "https://openrouter.ai/api/v1"
  # Model identifier to use (optional; default shown)
  model: "google/gemini-2.5-flash-lite"
  # Request timeout in seconds (optional; default: 60)
  timeout_seconds: 60
  # Max number of concurrent LLM requests (optional; default: 5)
  concurrency: 5

prompts:
  # Prompts define how summaries are produced.
  # Each prompt must have a unique id.
  - id: "default"
    prompt: "Generate an executive summary of the provided article."
  - id: "deep-dive"
    prompt: "Extract the nuanced arguments and counterpoints."

# minigist always appends a fixed system instruction that enforces JSON output
# and requires summary_markdown to be Markdown. This cannot be overridden.

# Optional: when no targets are defined, this prompt is used for all unread entries.
# If omitted, the first prompt in the "prompts" list is used.
default_prompt_id: "default"

targets:
  # Targets map feeds or categories to prompts.
  # When targets are defined, ONLY these feeds/categories are processed.
  # Overlaps across targets are errors.
  - prompt_id: "default"
    feed_ids: [1, 2]
  - prompt_id: "deep-dive"
    category_ids: [5]
    # Prefer pure.md for this target (optional; default: false)
    use_pure: true

scraping:
  # Token for pure.md (optional; improves rate limits)
  pure_api_token: "optional-pure-md-token"
  # Always route matching URLs through pure.md
  pure_base_urls:
    - "https://text.npr.org/"
  # Request timeout for scraping in seconds (optional; default: 5)
  timeout_seconds: 5

fetch:
  # Max unread entries to fetch per feed (optional; default: 50)
  limit: 50

notifications:
  # Apprise notification URLs for error/failure alerts (optional)
  - "discord://webhook_id/webhook_token"
  - "telegram://bot_token/chat_id"

See Apprise documentation for all supported notification services.

Keeping summaries

minigist writes each summary into the entry's content. When Miniflux refreshes a feed and sees that it changed, it rewrites the content of every entry still listed in that feed, and the summary is gone. minigist cannot tell that the summary was removed, so it summarizes the unread entries again on the next run and spends another LLM call on each.

Miniflux skips this rewrite for feeds that have "Ignore entry updates" or "Fetch original content" enabled. The miniflux.entry_updates setting decides what minigist does with feeds that have neither:

  • disable turns on "Ignore entry updates" for the feed before summarizing it. This is the default when targets are defined.
  • skip leaves the feed unchanged, logs a warning, and does not summarize it.
  • allow summarizes the feed anyway. This is the default without targets, since disable would then change every feed on your instance.

With "Ignore entry updates" on, Miniflux also stops picking up later edits the publisher makes to an article. minigist does not keep track of the feeds it changed, so if you drop a feed from your targets, turn the option off yourself in the feed settings. A forced refresh in Miniflux still rewrites the entries and removes their summaries.

This needs Miniflux 2.2.18 or later, the first release with "Ignore entry updates".

Run

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

Metadata

Release files for minigist 0.9.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for minigist 0.9.8
File Size Uploaded Provenance Actions
minigist-0.9.8.tar.gz 26.7 kB Without provenance Details for minigist-0.9.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for minigist 0.9.8
File Interpreter ABI Platform Actions
minigist-0.9.8-py3-none-any.whl Python 3 none any Details for minigist-0.9.8-py3-none-any.whl

Total release size: 58.0 kB

Release files / minigist-0.9.8.tar.gz

Download URL minigist-0.9.8.tar.gz
Size 26.7 kB
Tags Source
SHA-256 checksum
How to use checksums
76ddca758b0176de2099bdb09f740efff77396b87a3ecd05bbbd1097c1685c37
BLAKE2b-256 checksum
How to use checksums
ae1d55a8c11fa9273f2f5b996936af6181823a024265be271be6e6d7ca094e65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / minigist-0.9.8-py3-none-any.whl

Download URL minigist-0.9.8-py3-none-any.whl
Size 31.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
991c92808fb3c64c65196049fb21f62b060a3f25c15dd7ab2eda239020d1b7d8
BLAKE2b-256 checksum
How to use checksums
d074cceaaf2dbef8da45df3afa55c0f4eac3dc0245714d82ca0d61e3f0785872
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for minigist 0.9.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.9.8 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page