Implement Discourse-formatted report generator #6

Closed
opened 2026-01-05 21:33:25 -06:00 by b3nw · 0 comments
Owner

Overview

Generate markdown reports compatible with Discourse forum formatting.

Tasks

  • Create src/eve_mod/report.py
  • Generate summary table of violations
  • Generate detailed analysis for each violation
  • Include direct links to posts
  • Output to terminal with rich formatting
  • Save to markdown file in reports/ directory
  • Filename format: {username}_{date}.md

Report Format

## User Review: {username}
**Period:** {start_date} to {end_date}
**Posts Analyzed:** {count}
**Potential Violations:** {violation_count}

---

### Summary

| Date | Topic | Rule | Severity | Issue |
|------|-------|------|----------|-------|
| ... | [title](url) | 1.2 | Medium | Brief description |

---

### Detailed Analysis

#### [Topic Title](url)
**Date:** ... | **Rule 1.2 - Flaming** | **Severity: Medium**

> Quoted excerpt...

**Issue:** Explanation...

Acceptance Criteria

  • Report displays correctly in terminal
  • Markdown file renders correctly in Discourse preview
  • Links are clickable
## Overview Generate markdown reports compatible with Discourse forum formatting. ## Tasks - [ ] Create `src/eve_mod/report.py` - [ ] Generate summary table of violations - [ ] Generate detailed analysis for each violation - [ ] Include direct links to posts - [ ] Output to terminal with rich formatting - [ ] Save to markdown file in `reports/` directory - [ ] Filename format: `{username}_{date}.md` ## Report Format ```markdown ## User Review: {username} **Period:** {start_date} to {end_date} **Posts Analyzed:** {count} **Potential Violations:** {violation_count} --- ### Summary | Date | Topic | Rule | Severity | Issue | |------|-------|------|----------|-------| | ... | [title](url) | 1.2 | Medium | Brief description | --- ### Detailed Analysis #### [Topic Title](url) **Date:** ... | **Rule 1.2 - Flaming** | **Severity: Medium** > Quoted excerpt... **Issue:** Explanation... ``` ## Acceptance Criteria - Report displays correctly in terminal - Markdown file renders correctly in Discourse preview - Links are clickable
b3nw closed this issue 2026-01-05 21:41:12 -06:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: b3nw/eve-forum-moderator#6