gost-report

Category: Research & Analysis | Uploader: zevtos | Downloads: 0 | Version: v1.0（Latest）

Generate Russian academic reports (.docx) formatted to GOST 7.32 — лабораторные работы, отчёты по практике, курсовые проекты, ВКР, домашние задания для любого российского вуза (ИТМО, МГУ, СПбГУ, МФТИ, Бауманка, и т.д.). Use this skill whenever the user asks for a report по ГОСТ, лабораторную работу, отчёт по практике, курсовой проект, ВКР, или любой Russian-language student paper that needs proper title page, headings, page numbers, figure/table captions. Trigger this skill even if the user only mentions "лабораторная" or "отчёт" without naming a specific university — Russian-language context (references to ИТМО / МГУ / СПбГУ / университет / ГОСТ) is enough. ITMO is the default profile (preserves the original itmo-report behavior); other universities are supported via UniversityProfile.

Changelog: Source: GitHub https://github.com/zevtos/agentpipe

Directory Structure

Current level: tree/main/skills/gost-report/

📁 references/
- 📄 api.md 8.0 KB
- 📄 checklist.md 6.0 KB
- 📄 formulas.md 6.6 KB
- 📄 patterns.md 4.7 KB
- 📄 profiles.md 5.9 KB
📁 scripts/
- 📄 ensure_env.py 6.1 KB
- 📄 example_lab.py 3.5 KB
- 📄 example_other_university.py 3.2 KB
- 📄 gost_report.py 55.4 KB
- 📄 requirements.txt 40 B
📄 LICENSE 1.0 KB
📄 SKILL.md 13.7 KB

SKILL.md

---
name: gost-report
description: Generate Russian academic reports (.docx) formatted to GOST 7.32 — лабораторные работы, отчёты по практике, курсовые проекты, ВКР, домашние задания для любого российского вуза (ИТМО, МГУ, СПбГУ, МФТИ, Бауманка, и т.д.). Use this skill whenever the user asks for a report по ГОСТ, лабораторную работу, отчёт по практике, курсовой проект, ВКР, или любой Russian-language student paper that needs proper title page, headings, page numbers, figure/table captions. Trigger this skill even if the user only mentions "лабораторная" or "отчёт" without naming a specific university — Russian-language context (references to ИТМО / МГУ / СПбГУ / университет / ГОСТ) is enough. ITMO is the default profile (preserves the original itmo-report behavior); other universities are supported via UniversityProfile.
---

# GOST report generator

## ⛔ Правило №1 — приоритет выше всего остального

**Никогда не пиши длинное (`—`) или среднее (`–`) тире в тексте отчёта.** Ни в одном тексте, который ты передаёшь в `r.text(...)`, `r.task(...)`, `r.h1/h2/h3(...)`, `r.numbered([...])`, `r.bullet([...])`, в `caption` у `r.figure/r.table`, и в ячейках таблиц. Это правило важнее любых стилистических соображений — даже если ИИ-«хороший вкус» подсказывает, что тире здесь к месту, не ставь его.

Что писать вместо:
- В середине предложения между словами — запятая или точка с запятой. Было: «Москва — столица России». Пиши: «Москва, столица России» или переписывай: «Столица России — Москва» → «Столица России Москва» / «Москва является столицей» (но не используй штамп «является» — лучше: «Столица России Москва»).
- В диапазонах (1—5) — обычный дефис: 1-5.
- В прямой речи и тире пропуска подлежащего — переписывай предложение.

Библиотека дополнительно подстраховывается: любой текст, переданный в content-методы, проходит через автоматический санитайзер `_sanitize_prose`, который заменяет ` — ` / ` – ` на `, ` и одиночные `—`/`–` на `-`. **Не полагайся на санитайзер** — он подчищает за тобой, но текст, написанный сразу без тире, читается естественнее. Санитайзер это страховка, а не разрешение лениться.

**Исключения** (тире там ставит сама библиотека, по ГОСТ — менять нельзя):
- Авто-подписи рисунков: `Рисунок N — Описание`.
- Авто-подписи таблиц: `Таблица N — Описание`.

Эти префиксы формирует код, твой `caption` в них уже очищен. Поэтому когда ты пишешь `r.figure(path, "Схема сети")`, в документ попадёт «Рисунок 3 — Схема сети» — это правильно, тире здесь стоит библиотека, не ты.

## Writing style — обязательно соблюдать

Любой текст, который ты пишешь в отчёт (всё что идёт в `r.text(...)`, `r.task(...)`, и аргумент `caption` у `r.figure/r.table`), должен подчиняться этим правилам. Без исключений:

> Пиши в естественной, человеческой, русскоязычной манере, избегая «ИИ-тона» — чрезмерно правильных, формальных и шаблонных конструкций.
>
> Исключай длинные тире (—) и средние тире (–) — см. Правило №1 выше, оно категорично и важнее всего остального в этом разделе. Также исключай лишние кавычки (« »), канцеляризмы и корпоративный жаргон. Используй понятные, живые выражения и уместный разговорный жаргон, если он помогает донести смысл. Избегай повторяющихся фраз и чрезмерно сложных оборотов. Варьируй длину и ритм предложений, приближая текст к естественной речи человека.
>
> Приоритет — смысловая ясность, индивидуальный стиль и практическая ценность в каждом предложении. Каждое предложение должно быть осознанным, как у настоящего человека.

**Конкретные запрещённые обороты** (типичные ИИ-маркеры — никогда не пиши так):
- «В ходе выполнения работы было...»
- «В результате проведённого исследования...»
- «Данный / вышеуказанный / нижеследующий ...»
- «Является / представляет собой / осуществляется ...»
- «Стоит отметить, что ...» / «Необходимо подчеркнуть, что ...»
- «Таким образом, можно сделать вывод о том, что ...»

**Что писать вместо:** короткие фразы по делу. Если задание — вывести список файлов, пиши «Команда `ls -la` показывает все файлы, включая скрытые.» Не «Для решения данной задачи была применена команда `ls -la`, в результате чего было получено отображение всех файлов».

**Это правило НЕ распространяется на:**
- Автоматические подписи рисунков и таблиц (`Рисунок N — Описание`) — их формирует библиотека по жёсткому шаблону ГОСТ.
- Канонические заголовки структурных элементов (`Введение`, `Заключение`, `Список литературы`).
- Прямые цитаты из источников — приводи как есть.

## When to use

Любая русскоязычная академическая работа по ГОСТ: лабораторная, отчёт по практике, курсовая/курсовой проект, ВКР, домашнее задание/РГР. Не используй для презентаций, не-ГОСТ-документов, нерусских работ.

## Quickstart

**Запуск всегда через bootstrap.** Скилл управляет своим venv в `<skill_dir>/.venv/` сам — не запускай `pip install` глобально:

```bash
python3 <skill_dir>/scripts/ensure_env.py твой_скрипт.py
```

(`<skill_dir>` это папка где лежит `SKILL.md`. Bootstrap пробует `uv` → `conda --prefix` → `python -m venv`. Тёплые запуски ~30 мс, deps обновляются автоматически при апдейте скилла.)

**Минимальный пример** (ИТМО, дефолт):

```python
from gost_report import Report, TitleConfig

r = Report(TitleConfig(
    work_type="Лабораторная работа",
    work_number="№1",
    topic="Основы работы в командной строке Unix",
    student_name="Фамилия И.О.",
    student_group="P3XXX",
    teacher_name="Фамилия И.О.",
    teacher_degree="к.т.н.",
    teacher_position="доцент",
    teacher_label="Проверил",   # женщине: "Проверила"; ВКР/курсовая: "Руководитель"
    year="2026",
))

r.toc()
r.h1("Введение")
r.text("Цель работы освоить базовые команды Unix.")
r.h1("Выполнение работы")
r.task("Задание 1. Вывести список файлов.")
r.code("ls -la")
r.text("Команда показывает все файлы, включая скрытые.")
f1 = r.formula(r"\sum_{i=1}^{n} i = \frac{n(n+1)}{2}")
r.text(f"Сумма по формуле ({f1}).")
r.h1("Заключение")
r.numbered(["Команда ls освоена.", "Опции -a и -l изучены."])

r.save("/tmp/report.docx")
```

## API

| Method | What it does |
|---|---|
| `r.toc()` | Поле Word TOC. Скажи пользователю обновить через ПКМ → «Обновить поле». |
| `r.h1(text)`, `r.h2(text)`, `r.h3(text)` | Заголовки. h1 авто-капс и с новой страницы (профиль). |
| `r.text(text, bold=False, italic=False)` | Абзац основного текста (justify, отступ 1.25 см). |
| `r.task(text)` | Жирный «Задание N. ...». |
| `r.code(code)` | Блок моноширинного кода (Courier New 11). |
| `r.figure(image_path, caption, width_cm=None)` | Картинка + «Рисунок N — caption». Ширина клампится по печатной области. |
| `r.formula(latex, where=None) → int` | LaTeX-формула как нативное Word-уравнение, авто-номер «(N)» справа. Возвращает номер для ссылок. |
| `r.table(rows, caption, has_header=True)` | Таблица + «Таблица N — caption». |
| `r.numbered(items)`, `r.bullet(items)` | Списки. Каждый вызов стартует с 1 заново. |
| `r.page_break()` | Принудительный разрыв (редко нужен — h1 сам ставит). |
| `r.save(path)` | Сохранить .docx. |

### `TitleConfig` — часто переопределяемые поля

| Поле | Дефолт | Когда менять |
|---|---|---|
| `teacher_label` | `"Проверил"` | Женщина-преподаватель: `"Проверила"`. ВКР/курсовая: `"Руководитель"` / `"Руководительница"`. |
| `work_number` | `""` | Лабы с номерами: `"№1"`, `"№3"`. |
| `variant` | `""` | Лабы с вариантами: `"3"`. |
| `teacher_degree` | `""` | `"к.т.н."`, `"д.ф.-м.н."`. |
| `teacher_position` | `""` | `"доцент"`, `"профессор"`, `"ст. преподаватель"`. |

Обязательные: `work_type`, `topic`, `student_name`, `student_group`, `year`. Полный список (включая `city`, `ministry`, `university_*`, `faculty` для override профиля) — в `references/api.md`.

## Подробности — see references/

Загружай по необходимости (агент не должен держать это в контексте каждый раз):

- **`references/profiles.md`** — другие вузы: `GOST_PROFILE`, кастомный `UniversityProfile`, переопределение полей через `TitleConfig`.
- **`references/formulas.md`** — полный список поддерживаемых LaTeX-конструкций, edge cases, санитайзер vs LaTeX, отладка.
- **`references/patterns.md`** — структура для лаб, ВКР, курсовых, отчёта по практике, ДЗ.
- **`references/api.md`** — TitleConfig полный, поведенческие заметки (TOC поле, рестарт списков, нет кавычек у `topic`, картинки клампятся, санитайзер семантика).
- **`references/checklist.md`** — расширенный чек-лист валидации.

## Dependencies

Управляются автоматически через `scripts/ensure_env.py`. Список (см. `scripts/requirements.txt`):
- `python-docx>=1.1.0`
- `latex2mathml>=3.77.0`

## License

MIT — see `LICENSE`.

## Checklist

Перед сдачей файла проверь:
- [ ] Не нарушено ⛔ Правило №1 (длинные тире не использованы) и writing-style (естественный тон, без канцеляризмов).
- [ ] Титульник рендерится корректно.
- [ ] Нумерация страниц со 2-й (на титульнике номера нет).
- [ ] У всех `figure()`/`table()` есть подписи.
- [ ] Если использовались формулы: каждая открывается в Word как уравнение (не сырой LaTeX-текст), номер «(N)» прижат справа.
- [ ] В примерах нет реальных имён, только «Фамилия И.О.».
- [ ] venv в одной папке `<skill_dir>/.venv` — не разбежался по проекту, не закоммичен в git, не утянулся в zip.

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

gost-report

Directory Structure

SKILL.md

Report

Notice