Issue Reporter

Issue Reporter is a Python library that provides a user-friendly GUI for reporting issues or bugs in applications. It simplifies the process of collecting, formatting, and sending issue reports via email using the Mailgun API.

Features

• Easy-to-use GUI dialog for collecting issue information from users
• Automatic system information collection
• Internationalization support
• Integration with Mailgun for sending emails

Installation

You can install Issue Reporter using pip:

pip install issue-reporter

Usage

The primary way to use Issue Reporter is through its GUI. Here's how to integrate it into your application:

from issue_reporter.gui import IssueReporterDialog
from issue_reporter import IssueReporter
import wx

# Initialize the IssueReporter
reporter = IssueReporter(
    from_address='errors@yourdomain.com',
    to_address='support@yourdomain.com',
    mailgun_api_key='your-mailgun-api-key'
)

# Create and show the dialog
app = wx.App()
dialog = IssueReporterDialog(None)
if dialog.ShowModal() == wx.ID_OK:
    report = dialog.get_report()
    reporter.send_report(report)
dialog.Destroy()
app.MainLoop()

This code snippet will display a dialog box for the user to fill out the issue report. When the user clicks OK, the report is automatically sent using the configured IssueReporter.

Configuration

The IssueReporter class requires the following parameters:

• from_address: The email address from which the reports will be sent
• to_address: The email address to which the reports will be sent
• mailgun_api_key: Your Mailgun API key

Internationalization

Issue Reporter supports internationalization. The GUI automatically uses the appropriate translation based on the system's locale settings. Translations are available in several languages, including German, Spanish, French, and more.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development

Run the complete offline test suite from the repository root:

uv run --isolated --no-project --with pytest==9.1.1 pytest -v

The tests load the real report implementation with mocked Mailgun, system information, and log-file boundaries. They use no project dependencies, service credentials, service requests, or real system inventory. The former live sending smoke test is replaced by assertions for report construction, message fields, delivery options, and successful attachment handling. There is no live integration test in the default suite.

CI runs the same complete suite and package build on Linux with CPython 3.8 (pytest 8.3.5) and 3.13 (pytest 9.1.1). When running the command above on Python 3.8, use pytest==8.3.5 in place of pytest==9.1.1.

Build the wheel and source distribution:

uv build

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Support

If you encounter any problems or have any questions, please open an issue on the GitHub repository.

---

Copyright (c) 2023 Christopher Toth