suaidoc 0.2.5

CLI for generating reports from Markodwn according to GOST 7.32

SUAIDOC

СLI утилита для генерации отчетов из Markdown по ГОСТ-7.32.

Просто вызовите в терминале suaidoc create my_awesome.md и получите отчет в PDF. Магия!

Установка

Утилита является Python пакетом, поэтому для установки утилиты достаточно в терминале написать:

pip3 install suaidoc --upgrade

или

pip install suaidoc --upgrade

Теперь нужно установить утилиты, требуемые для работы:

macOS

Можно установить с помощью brew. Для установки вставьте в терминал:

brew install pandoc
brew install --cask wkhtmltopdf
brew install --cask mactex-no-gui

Во время установки потребуется ввести пароль.

Установка mactex-no-gui может занять много времени. Если хочется побыстрее, то можно установить MacTeX вручную. GUI приложения затем можно спокойно удалить.

Windows

Можно установить с помощью chocolatey. Для установки вставьте в терминал от имени администратора:

choco install pandoc
choco install wkhtmltopdf
choco install miktex.install

Установка вручную

Если установка с помощью пакет-менеджеров выше не удалась, то требуется установить отсутствующие утилиты вручную.

Если вы не пробовали установку с помощью пакет-менеджеров, то сначала попробуйте ее. Она легче, быстрее и менее муторная.

Pandoc

Pandoc используется для генерации Markdown в PDF.

1. Перейдите на сайт Pandoc и выберите нужный установщик.
2. Убедитесь, что выбрана настройка для добавления pandoc в PATH!
3. После установки проверьте, что pandoc можно вызвать из терминала.

wkhtmltopdf

Для генерации титульной страницы из HTML в PDF.

1. Перейдите на сайт wkhtmltopdf и выберите нужный установщик.
2. Запомните расположение, куда был установлен wkhtmltopdf.
3. Скорее всего, после установки wkhtmltopdf не будет добавлен в PATH. Поэтому добавьте путь из предыдущего шага к PATH.
4. Проверьте, что wkhtmltopdf можно вызвать из терминала.

LaTeX

MiKTeX используется из-за удобства и нужных встроенных пакетов.

1. Перейдите на сайт MikTex и выберите нужный установщик.
2. Следуйте шагам установки, обязательно выбрав опцию для автоматического обновления.
3. Запустите приложение MikTex console от администратора и на главной странице проверьте автоматические обновления. Установите обновление, если это возможно.

Примеры

Примеры представлены в папке example.

• Использование форматирования
• Отчеты для моих лаб

ГОСТ 7.32

Это утилита не стремится строго следовать ГОСТ 7.32. Прежде всего утилита предназначена для облегчения написания отчетов студентов. Поэтому часть стандартов, которая усложнит написание, использование или структурирование - незначительно изменены. Для более комплексных научных работ, стоит выбрать другие решения, например latex-g7-32.

Для простых лабораторных, практических работ suaidoc является идеальным решением!

Команды

В suaidoc для каждой команды определен флаг --help. Если вам нужна справка по какой-то, вызовите команду с флагом --help. Например, suaidoc --help

Текущие команды:

• create - создание PDF отчета из Markdown.
• template - создание Markdown шаблона в текущей директории.