https://github.com/grahfmusic/issueguardian

A Python based Linux command line tool designed to monitor, identify, and alert of unassigned JIRA issues. It aims to ensure that all issues in a JIRA project receive prompt attention and are assigned appropriately, aiding teams in maintaining efficient workflows and project management practices.
https://github.com/grahfmusic/issueguardian

console console-application jira linux

Last synced: 4 days ago
JSON representation

A Python based Linux command line tool designed to monitor, identify, and alert of unassigned JIRA issues. It aims to ensure that all issues in a JIRA project receive prompt attention and are assigned appropriately, aiding teams in maintaining efficient workflows and project management practices.

• Host: GitHub
• URL: https://github.com/grahfmusic/issueguardian
• Owner: grahfmusic
• Created: 2024-04-10T14:46:30.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2025-01-07T13:03:14.000Z (7 days ago)
• Last Synced: 2025-01-07T14:22:38.737Z (7 days ago)
• Topics: console, console-application, jira, linux
• Language: Python
• Homepage:
• Size: 194 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# IssueGuardian

**IssueGuardian** is a Python-based tool designed to monitor, identify, and alert on unassigned JIRA issues. It aims to ensure that all issues in a JIRA project receive prompt attention and are assigned appropriately, aiding teams in maintaining efficient workflows and project management practices.



## Features

- **Automatic Detection**: Scans the JIRA project for unassigned issues based on predefined criteria.

- **Email Alerts**: Sends detailed reports via email to specified recipients, including issue summaries, priorities, and direct links for quick navigation.

- **Customisable Configuration**: Allows configuration of JIRA credentials, project settings, and email details through an easy-to-use configuration file.

- **Logging**: Provides comprehensive logging of operations, facilitating easy troubleshooting and monitoring of the tool's activities.

## Getting Started

### Prerequisites

- Python 3.6 or higher

- `requests` library for making API requests

- Access to a JIRA project with API access enabled

- SMTP server credentials for sending email alerts

### Configuration

Edit the `config.ini` file to set up your JIRA access and email settings:

- `[jira]`: JIRA server URL, credentials, and project settings.

- `[email]`: SMTP server details and sender email address.

## Documentation

### Modules

- `ApplicationInfo`: Displays startup information and application details.

- `ConfigValidator`: Validates the provided configuration against required settings.

- `JiraApi`: Interfaces with the JIRA REST API to fetch unassigned issues.

- `EmailReport`: Generates and sends an email report based on the fetched issues.

### Functions

- `display_app_info()`: Prints application information.

- `validate(config)`: Validates the application's configuration.

- `fetch_unassigned_issues()`: Fetches unassigned issues from JIRA.

- `generate_email_body(issues)`: Generates the HTML body for the email report.

- `send(issues)`: Sends the email report to specified recipients.