Skip to content
This repository was archived by the owner on Mar 27, 2026. It is now read-only.

refactor!: simplified nitrodigest#124

Merged
RetroModernDev merged 7 commits intomainfrom
refactor/simplify-nitrodigest
May 1, 2025
Merged

refactor!: simplified nitrodigest#124
RetroModernDev merged 7 commits intomainfrom
refactor/simplify-nitrodigest

Conversation

@RetroModernDev
Copy link
Copy Markdown
Owner

@RetroModernDev RetroModernDev commented May 1, 2025

BREAKING CHANGES:

  • The email reader is no longer available. From now user passes text or a directory that should be summarized
  • Claude and OpenAI are no longer available. nitrodigest focuses only on local LLM

After this refactoring, the usage of this tool looks like this:

python main.py --input <file or directory you want to summarize>

Config structure:

{
    "model": "mistral",
    "ollama_api_url": "http://localhost:11434",
    "timeout": 300,
    "prompt_file": "prompt_template.txt",
    "summaries_path": "summaries"
}

I updated README plus added some sample newsletters for testing purposes.

nitrodigest in action now:
Screenshot 2025-05-01 at 14 56 30

Closes #119

Also refactored and simplified config and main file. From now is not needed to specify summarizer type because, program uses only Ollama

BREAKING CHANGE: OpenAI and Claude are no avaialbale for summarizing anymore. the type field in config is removed
From now user needs to read emails and prepare data for summarizing outside this program.
nitrodigest from now do two things:
1. summmarize (one file or files in a directory)
2. save summarized text to a file

User can pass file or folder via argument.

Besides I simplified config and from now it's a flat objects

BREAAKING CHANGE: program doesn't process emails, it expects that text to summarize will be provided by user
Copilot AI review requested due to automatic review settings May 1, 2025 13:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors NitroDigest by removing email processing and remote LLM support in favor of a simplified, local-only text/directory summarization workflow. Key changes include:

  • Removal of Claude and OpenAI providers and associated email processing components.
  • Updates to the CLI to accept a file or directory as input.
  • Config and documentation changes to reflect the focus on local summarization via Ollama.

Reviewed Changes

Copilot reviewed 16 out of 19 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
nitrodigest/summary_writer.py Updated file writing logic and logging message improvements.
nitrodigest/summarizer/providers/openai.py Removed OpenAI summarizer implementation.
nitrodigest/summarizer/providers/claude.py Removed Claude summarizer implementation.
nitrodigest/summarizer/providers/init.py Removed unused provider imports.
nitrodigest/summarizer/ollama.py Updated variable names and API endpoints for clarity.
nitrodigest/main.py Reworked CLI and processing logic to accept file/directory input.
nitrodigest/config.py Simplified configuration data structure.
nitrodigest/README.md Updated documentation and configuration snippet.
Files not reviewed (3)
  • nitrodigest/config.json.example: Language not supported
  • nitrodigest/prompt_template2.txt: Language not supported
  • nitrodigest/requirements.txt: Language not supported

Comment thread nitrodigest/README.md Outdated
Comment thread nitrodigest/main.py Outdated
Comment thread nitrodigest/main.py
RetroModernDev and others added 3 commits May 1, 2025 15:05
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@RetroModernDev RetroModernDev merged commit d186954 into main May 1, 2025
4 checks passed
@RetroModernDev RetroModernDev deleted the refactor/simplify-nitrodigest branch May 1, 2025 13:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants