Initial commit
This commit is contained in:
1
redmine_reporter/__init__.py
Normal file
1
redmine_reporter/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
__version__ = "1.0.0"
|
||||
74
redmine_reporter/cli.py
Normal file
74
redmine_reporter/cli.py
Normal file
@@ -0,0 +1,74 @@
|
||||
import sys
|
||||
import argparse
|
||||
from typing import List, Optional
|
||||
from redminelib.resources import Issue
|
||||
from .config import Config
|
||||
from .client import fetch_issues_by_time_entries
|
||||
from .formatter import format_compact, format_table
|
||||
|
||||
|
||||
def parse_date_range(date_arg: str) -> tuple[str, str]:
|
||||
if "--" not in date_arg:
|
||||
raise ValueError("Date range must be in format YYYY-MM-DD--YYYY-MM-DD")
|
||||
parts = date_arg.split("--", 1)
|
||||
if len(parts) != 2:
|
||||
raise ValueError("Invalid date range format")
|
||||
return parts[0].strip(), parts[1].strip()
|
||||
|
||||
|
||||
def main(argv: Optional[List[str]] = None) -> int:
|
||||
parser = argparse.ArgumentParser(
|
||||
prog="redmine-reporter",
|
||||
description="Generate Redmine issue report based on your time entries."
|
||||
)
|
||||
parser.add_argument(
|
||||
"--date",
|
||||
default=Config.DEFAULT_DATE_RANGE,
|
||||
help="Date range in format YYYY-MM-DD--YYYY-MM-DD (default: %(default)s)"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--compact",
|
||||
action="store_true",
|
||||
help="Use compact plain-text output instead of table"
|
||||
)
|
||||
args = parser.parse_args(argv)
|
||||
|
||||
try:
|
||||
Config.validate()
|
||||
except ValueError as e:
|
||||
print(f"❌ Configuration error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
try:
|
||||
from_date, to_date = parse_date_range(args.date)
|
||||
except ValueError as e:
|
||||
print(f"❌ Date error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
try:
|
||||
issues = fetch_issues_by_time_entries(from_date, to_date)
|
||||
except Exception as e:
|
||||
print(f"❌ Redmine API error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
if issues is None:
|
||||
print("ℹ️ No time entries found in the given period.", file=sys.stderr)
|
||||
return 0
|
||||
|
||||
print(f"✅ Total issues: {len(issues)} [{args.date}]")
|
||||
|
||||
try:
|
||||
if args.compact:
|
||||
output = format_compact(issues)
|
||||
else:
|
||||
output = format_table(issues)
|
||||
print(output)
|
||||
except Exception as e:
|
||||
print(f"❌ Formatting error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
41
redmine_reporter/client.py
Normal file
41
redmine_reporter/client.py
Normal file
@@ -0,0 +1,41 @@
|
||||
from typing import List, Optional, Set
|
||||
from redminelib import Redmine
|
||||
from redminelib.resources import Issue
|
||||
from .config import Config
|
||||
|
||||
|
||||
def fetch_issues_by_time_entries(from_date: str, to_date: str) -> Optional[List[Issue]]:
|
||||
"""
|
||||
Fetch unique issues linked to time entries of the current user in given date range.
|
||||
"""
|
||||
|
||||
redmine = Redmine(
|
||||
Config.REDMINE_URL,
|
||||
username=Config.REDMINE_USER,
|
||||
password=Config.REDMINE_PASSWORD
|
||||
)
|
||||
|
||||
current_user = redmine.user.get('current')
|
||||
time_entries = redmine.time_entry.filter(
|
||||
user_id=current_user.id,
|
||||
from_date=from_date,
|
||||
to_date=to_date
|
||||
)
|
||||
|
||||
issue_ids: Set[int] = set()
|
||||
for entry in time_entries:
|
||||
if hasattr(entry, 'issue') and entry.issue:
|
||||
issue_ids.add(entry.issue.id)
|
||||
|
||||
if not issue_ids:
|
||||
return None
|
||||
|
||||
# Fetch full issue objects with project/version/status
|
||||
issue_list_str = ','.join(str(i) for i in issue_ids)
|
||||
issues = redmine.issue.filter(
|
||||
issue_id=issue_list_str,
|
||||
status_id='*',
|
||||
sort='project:asc'
|
||||
)
|
||||
|
||||
return list(issues)
|
||||
21
redmine_reporter/config.py
Normal file
21
redmine_reporter/config.py
Normal file
@@ -0,0 +1,21 @@
|
||||
import os
|
||||
from dotenv import load_dotenv
|
||||
|
||||
|
||||
load_dotenv()
|
||||
|
||||
|
||||
class Config:
|
||||
REDMINE_URL = os.getenv("REDMINE_URL", "").rstrip("/")
|
||||
REDMINE_USER = os.getenv("REDMINE_USER")
|
||||
REDMINE_PASSWORD = os.getenv("REDMINE_PASSWORD")
|
||||
DEFAULT_DATE_RANGE = "2025-12-19--2026-01-31"
|
||||
|
||||
@classmethod
|
||||
def validate(cls) -> None:
|
||||
if not cls.REDMINE_URL:
|
||||
raise ValueError("REDMINE_URL is required (set via env or .env)")
|
||||
if not cls.REDMINE_USER:
|
||||
raise ValueError("REDMINE_USER is required")
|
||||
if not cls.REDMINE_PASSWORD:
|
||||
raise ValueError("REDMINE_PASSWORD is required")
|
||||
70
redmine_reporter/formatter.py
Normal file
70
redmine_reporter/formatter.py
Normal file
@@ -0,0 +1,70 @@
|
||||
from typing import List
|
||||
from redminelib.resources import Issue
|
||||
|
||||
|
||||
STATUS_TRANSLATION = {
|
||||
'Closed': 'Закрыто',
|
||||
'Re-opened': 'В работе',
|
||||
'New': 'В работе',
|
||||
'Resolved': 'Решена',
|
||||
'Pending': 'Ожидание',
|
||||
'Feedback': 'В работе',
|
||||
'In Progress': 'В работе',
|
||||
'Rejected': 'Закрыто',
|
||||
'Confirming': 'Ожидание',
|
||||
}
|
||||
|
||||
|
||||
def get_version(issue: Issue) -> str:
|
||||
return str(getattr(issue, 'fixed_version', '<N/A>'))
|
||||
|
||||
|
||||
def format_compact(issues: List[Issue]) -> str:
|
||||
lines = []
|
||||
prev_project = None
|
||||
prev_version = None
|
||||
|
||||
for issue in issues:
|
||||
project = str(issue.project)
|
||||
version = get_version(issue)
|
||||
status = str(issue.status)
|
||||
|
||||
display_project = project if project != prev_project else ""
|
||||
display_version = version if (project != prev_project or version != prev_version) else ""
|
||||
|
||||
lines.append(f"{display_project} | {display_version} | {issue.id}. {issue.subject} | {status}")
|
||||
|
||||
prev_project = project
|
||||
prev_version = version
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
|
||||
def format_table(issues: List[Issue]) -> str:
|
||||
from tabulate import tabulate
|
||||
|
||||
rows = [['Проект', 'Версия', 'Задача', 'Статус', 'Затрачено']]
|
||||
prev_project = None
|
||||
prev_version = None
|
||||
|
||||
for issue in issues:
|
||||
project = str(issue.project)
|
||||
version = get_version(issue)
|
||||
status_en = str(issue.status)
|
||||
status_ru = STATUS_TRANSLATION.get(status_en, status_en)
|
||||
|
||||
display_project = project if project != prev_project else ""
|
||||
display_version = version if (project != prev_project or version != prev_version) else ""
|
||||
|
||||
rows.append([
|
||||
display_project,
|
||||
display_version,
|
||||
f"{issue.id}. {issue.subject}",
|
||||
status_ru,
|
||||
"" # placeholder for spent time (future extension)
|
||||
])
|
||||
|
||||
prev_project = project
|
||||
prev_version = version
|
||||
|
||||
return tabulate(rows, headers="firstrow", tablefmt="fancy_grid")
|
||||
Reference in New Issue
Block a user