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.
- Перейдите на сайт Pandoc и выберите нужный установщик.
- Убедитесь, что выбрана настройка для добавления pandoc в
PATH! - После установки проверьте, что pandoc можно вызвать из терминала.
wkhtmltopdf
Для генерации титульной страницы из HTML в PDF.
- Перейдите на сайт wkhtmltopdf и выберите нужный установщик.
- Запомните расположение, куда был установлен wkhtmltopdf.
- Скорее всего, после установки wkhtmltopdf не будет добавлен в
PATH. Поэтому добавьте путь из предыдущего шага кPATH. - Проверьте, что wkhtmltopdf можно вызвать из терминала.
LaTeX
MiKTeX используется из-за удобства и нужных встроенных пакетов.
- Перейдите на сайт MikTex и выберите нужный установщик.
- Следуйте шагам установки, обязательно выбрав опцию для автоматического обновления.
- Запустите приложение MikTex console от администратора и на главной странице проверьте автоматические обновления. Установите обновление, если это возможно.
Примеры
Примеры представлены в папке example.
ГОСТ 7.32
Это утилита не стремится строго следовать ГОСТ 7.32. Прежде всего утилита предназначена для облегчения написания отчетов студентов. Поэтому часть стандартов, которая усложнит написание, использование или структурирование - незначительно изменены. Для более комплексных научных работ, стоит выбрать другие решения, например latex-g7-32.
Для простых лабораторных, практических работ suaidoc является идеальным решением!
Команды
В suaidoc для каждой команды определен флаг --help. Если вам нужна справка по какой-то, вызовите команду с флагом --help. Например, suaidoc --help
Текущие команды:
create- создание PDF отчета из Markdown.template- создание Markdown шаблона в текущей директории.
Metadata
Release files for suaidoc 0.2.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| suaidoc-0.2.5.tar.gz | 13.4 kB | Without provenance | Details for suaidoc-0.2.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| suaidoc-0.2.5-py3-none-any.whl | Python 3 | none | any | Details for suaidoc-0.2.5-py3-none-any.whl |
Total release size: 25.4 kB
Release files / suaidoc-0.2.5.tar.gz
| Download URL | suaidoc-0.2.5.tar.gz |
|---|---|
| Size | 13.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0373a74ca336266217334c30a277460582a21131660dab7c60fd25480739e0a7
|
|
BLAKE2b-256 checksum How to use checksums |
fe84145018305cf71c8d2a05c84edc8ce43b6834f6fe7d061fc549e3edc6c493
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.7
|
Release files / suaidoc-0.2.5-py3-none-any.whl
| Download URL | suaidoc-0.2.5-py3-none-any.whl |
|---|---|
| Size | 11.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d8d0317851846511bca3cb5b5790000484b2946e1d838018255450050c0b1ef1
|
|
BLAKE2b-256 checksum How to use checksums |
df4132ebfa4eefc3402004b1febf87f7a486417da2ec4812a04ade26cdf007de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.7
|
Security for suaidoc 0.2.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.