Мониторинг и отчёты

Markdown-отчет из CSV

Строит Markdown-таблицу с данными и сводкой по числовым колонкам.

Python Windows macOS Linux Средний
Скачать markdown_report.py
Описание

Что делает скрипт

Скрипт читает CSV и формирует аккуратный Markdown с заголовком, временем генерации и таблицей. Числовые колонки получают сводку min, max и avg. Файл записывается атомарно, pipes в данных экранируются.

Перед запуском
  • Перезаписывает выходной Markdown-файл.
Запуск

Быстрый старт

python markdown_report.py --input metrics.csv --output report.md

Скачайте файл, откройте терминал в папке со скриптом и выполните команду. В Linux и macOS интерпретатор может называться python3, в Windows - python или py.

Примеры

Другие варианты

  • python markdown_report.py --input metrics.csv --output report.md --title 'Weekly metrics'
  • python markdown_report.py --input metrics.csv --output report.md --max-rows 100
Зависимости

Что понадобится

Python 3.10+ Только стандартная библиотека
Windows winget install Python.Python.3.12
macOS brew install python
Linux sudo apt install python3
Исходник

markdown_report.py

#!/usr/bin/env python3
"""Строит Markdown-отчет из CSV."""
from __future__ import annotations

import argparse
import csv
import os
import sys
import tempfile
from datetime import datetime, timezone
from pathlib import Path


def escape_cell(value) -> str:
    text = str(value).replace("|", "\\|").replace("\n", " ")
    return text


def numeric_summary(rows: list[dict], field: str) -> dict | None:
    values = []
    for row in rows:
        try:
            values.append(float(row[field]))
        except (KeyError, TypeError, ValueError):
            continue
    if not values:
        return None
    return {
        "count": len(values),
        "min": min(values),
        "max": max(values),
        "avg": sum(values) / len(values),
    }


def main() -> int:
    parser = argparse.ArgumentParser(description="Markdown-отчет из CSV")
    parser.add_argument("--input", required=True, type=Path)
    parser.add_argument("--output", required=True, type=Path)
    parser.add_argument("--title", default="Monitoring report")
    parser.add_argument("--max-rows", type=int, default=200)
    args = parser.parse_args()

    try:
        handle = args.input.open("r", encoding="utf-8", newline="")
    except OSError as error:
        print(f"ОШИБКА: {error}", file=sys.stderr)
        return 2

    with handle:
        reader = csv.DictReader(handle)
        fields = reader.fieldnames or []
        rows = list(reader)

    if not fields:
        print("В CSV нет заголовка", file=sys.stderr)
        return 2

    lines = [f"# {args.title}", ""]
    generated = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S UTC")
    lines.append(f"Сформировано: {generated}. Строк: {len(rows)}.")
    lines.append("")

    summaries = []
    for field in fields:
        summary = numeric_summary(rows, field)
        if summary:
            summaries.append((field, summary))
    if summaries:
        lines.extend(["## Сводка", "", "| Поле | Точек | Минимум | Максимум | Среднее |", "| --- | ---: | ---: | ---: | ---: |"])
        for field, value in summaries:
            lines.append(
                f"| {escape_cell(field)} | {value['count']} | {value['min']:.3f} | "
                f"{value['max']:.3f} | {value['avg']:.3f} |"
            )
        lines.append("")

    lines.extend(["## Данные", ""])
    lines.append("| " + " | ".join(escape_cell(field) for field in fields) + " |")
    lines.append("| " + " | ".join("---" for _ in fields) + " |")
    for row in rows[: max(args.max_rows, 0)]:
        lines.append("| " + " | ".join(escape_cell(row.get(field, "")) for field in fields) + " |")
    if len(rows) > max(args.max_rows, 0):
        lines.append("")
        lines.append(f"Показано {max(args.max_rows, 0)} из {len(rows)} строк.")
    document = "\n".join(lines) + "\n"

    target = args.output.expanduser()
    if not target.parent.is_dir():
        print(f"Каталог не найден: {target.parent}", file=sys.stderr)
        return 2

    descriptor, temporary = tempfile.mkstemp(dir=target.parent, prefix=".report-", suffix=".md")
    try:
        with os.fdopen(descriptor, "w", encoding="utf-8") as output:
            output.write(document)
        os.replace(temporary, target)
    except OSError as error:
        print(f"ОШИБКА: {error}", file=sys.stderr)
        return 2

    print(f"Отчет записан: {target}")
    return 0


if __name__ == "__main__":
    raise SystemExit(main())

Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get monitoring-markdown-report
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Мониторинг и отчёты

Сбор метрик, проверка доступности, отчёты и уведомления.