Design Feedback Summarizer

What It Does

Installation

git clone https://github.com/your-repo/design-feedback-summarizer.git
   cd design-feedback-summarizer

pip install -r requirements.txt

Usage

[
    "Great design!",
    "Navigation is confusing.",
    "Add more color themes."
]

{
    "summary": "Users appreciate the clean design but find navigation confusing.",
    "recommendations": [
        "Improve navigation clarity by adding labels to icons.",
        "Provide a tutorial for first-time users."
    ]
}

Source Code

import argparse
import json
import os
import requests
import numpy as np
import pandas as pd

def call_claude_api(feedback_text):
    """
    Mock function to simulate calling the Claude API.
    Replace this with actual API integration.

    Args:
        feedback_text (str): The feedback text to summarize.

    Returns:
        dict: A dictionary containing the summary and recommendations.
    """
    # Simulated response
    return {
        "summary": "Users appreciate the clean design but find navigation confusing.",
        "recommendations": [
            "Improve navigation clarity by adding labels to icons.",
            "Provide a tutorial for first-time users."
        ]
    }

def summarize_feedback(input_file, output_file=None, output_format="json"):
    """
    Summarizes feedback from a JSON or text file and outputs the result.

    Args:
        input_file (str): Path to the input file (JSON or plain text).
        output_file (str, optional): Path to save the output. Defaults to None.
        output_format (str, optional): Output format, either 'json' or 'text'. Defaults to 'json'.

    Returns:
        dict: Summary and recommendations.
    """
    if not os.path.exists(input_file):
        raise FileNotFoundError(f"Input file '{input_file}' does not exist.")

    # Read input file
    if input_file.endswith(".json"):
        with open(input_file, "r", encoding="utf-8") as f:
            feedback_data = json.load(f)
        if not isinstance(feedback_data, list):
            raise ValueError("JSON file must contain a list of feedback strings.")
        feedback_text = "\n".join(feedback_data)
    elif input_file.endswith(".txt"):
        with open(input_file, "r", encoding="utf-8") as f:
            feedback_text = f.read()
    else:
        raise ValueError("Unsupported file format. Use .json or .txt files.")

    # Call the Claude API (mocked here)
    try:
        result = call_claude_api(feedback_text)
    except requests.RequestException as e:
        raise ConnectionError("Failed to connect to the Claude API.") from e

    # Format output
    if output_format == "json":
        output_data = json.dumps(result, indent=4)
    elif output_format == "text":
        output_data = f"Summary:\n{result['summary']}\n\nRecommendations:\n" + "\n".join(result['recommendations'])
    else:
        raise ValueError("Unsupported output format. Use 'json' or 'text'.")

    # Save to file if output_file is specified
    if output_file:
        with open(output_file, "w", encoding="utf-8") as f:
            f.write(output_data)

    return result

if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Design Feedback Summarizer")
    parser.add_argument("input_file", help="Path to the input file (JSON or plain text).")
    parser.add_argument("--output_file", help="Path to save the output file.", default=None)
    parser.add_argument("--output_format", help="Output format: 'json' or 'text'.", default="json")

    args = parser.parse_args()

    try:
        summarize_feedback(args.input_file, args.output_file, args.output_format)
        print("Feedback summarized successfully.")
    except Exception as e:
        print(f"Error: {e}")