1.7 KiB

Raw Permalink Blame History

gen-report

CLI tool to consolidate individual weekly member reports (Word / Markdown) into a single department weekly report using an LLM (via litellm). It can optionally leverage historical example weeks (few-shot) to steer style and structure.

Features

check use_cases.md for details.

Environment

Get your API key from the respective provider.

Set an API key supported by litellm (Gemini preferred default):

setx GOOGLE_API_KEY "your_gemini_key"  # Windows PowerShell (Gemini)

You can also use: GEMINI_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, AZURE_OPENAI_API_KEY, GROQ_API_KEY.

Usage

uv run python -m gen_report -h
uv run python -m gen_report --source ./this_week --examples ./history1 -e ./history2 --out dept_report_20240821.md \
	--model gemini/gemini-1.5-flash

Dry run (print prompt only, no LLM call):

uv run python -m gen_report -s ./this_week -e ./history1 -e ./history2 --dry-run
uv run python -m gen_report -s ./this_week -e ./history1 --dry-run

build(not supported yet)

uv run nuitka --onefile --assume-yes-for-downloads src/gen_report # take a long time
./gen_report.exe -h

Folder Layout Expectations

this_week/
	Alice工作報告-20240821.docx
	Bob工作報告-20240821.md
history1/
	Alice工作報告-20240814.docx
	Bob工作報告-20240814.docx
	114年08月7日~ 114年08月13日之工作報告_20240814.docx
history2/
	Alice工作報告-20240814.docx
	Bob工作報告-20240814.docx
	114年04月24日~ 114年04月30日之工作報告_20240814.docx

Development

Run locally without install:

uv run python -m gen_report -s ./this_week --dry-run

1.7 KiB Raw Permalink Blame History