latex-generator-neimess-itmo 0.1.2

ITMO-lab-2-project

📄 latex-generator-neimess-itmo

latex-generator-neimess-itmo — это Python-библиотека для удобного создания кода LaTeX с таблицами и изображениями. Она позволяет легко формировать таблицы (mtx) и вставлять изображения (image_latex) в .tex-файлы.

---

Установка

Установить библиотеку можно через PyPI:

pip install latex-generator-neimess-itmo

---

Использование

Генерация таблицы в LaTeX

from latex-generator-neimess-itmo.latex_utils import mtx

matrix = [
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9]
]

table_code = mtx(matrix, caption="Пример таблицы", label="tab:example", table_env=True)
print(table_code)

📌 Вывод:

\documentclass{article}

\begin{document}
\begin{table}[h]
\begin{tabular}{|c|c|c|}
\hline
1 & 2 & 3 \\\hline
4 & 5 & 6 \\\hline
7 & 8 & 9 \\\hline
\end{tabular}
\caption{Пример таблицы}
\label{tab:example}
\end{table}
\end{document}

---

🔹 Добавление изображения в LaTeX

from latex-generator-neimess-itmo.latex_utils import image_latex

image_code = image_latex("example.png", caption="Пример изображения", label="fig:example")
print(image_code)

📌 Вывод:

\documentclass{article}
\usepackage{graphicx}
\begin{document}
\begin{figure}[h]
\centering
\includegraphics[width=\textwidth]{example.png}
\caption{Пример изображения}
\label{fig:example}
\end{figure}
\end{document}

---

📄 Генерация PDF-файла

Можно объединить таблицу и изображение и скомпилировать .tex в PDF:

from latex-generator-neimess-itmo.latex_utils import mtx, image_latex
import subprocess

# Данные
matrix = [[1, 2], [3, 4]]

# Генерация LaTeX-кода
table_code = mtx(matrix, caption="Таблица", label="tab:my_table", table_env=True)
image_code = image_latex("example.png", caption="Изображение", label="fig:my_image")

# Создание документа
latex_doc = f"""
\documentclass{article}
\usepackage{graphicx}
\begin{document}

{table_code}

{image_code}

\end{document}
"""

# Сохранение в файл
with open("document.tex", "w") as f:
    f.write(latex_doc)

# Компиляция в PDF (требуется установленный TeX Live / MiKTeX)
subprocess.run(["pdflatex", "document.tex"])

📌 После выполнения появится файл document.pdf с таблицей и изображением.

---

🛠 Параметры функций

📌 mtx(matrix, **kwargs)

Параметр	Тип	Описание
matrix	List[List[object]]	Двумерный список с данными таблицы
hlines	bool	Включить горизонтальные линии (по умолчанию True)
vlines	bool	Включить вертикальные линии (по умолчанию True)
col_align	str	Выравнивание столбцов ("c", "l", "r")
table_env	bool	Заворачивать в table-окружение (по умолчанию False)
pos	str	Позиция таблицы ("h", "H", "t", "b", "p")
caption	str	Описание таблицы
label	str	Метка для ссылки на таблицу

---

📌 image_latex(image_path, **kwargs)

Параметр	Тип	Описание
image_path	str	Путь к изображению
centering	bool	Центрирование (по умолчанию True)
position	str	Позиция ("h", "t", "b", "p", "!")
caption	str	Описание изображения
label	str	Метка для ссылки на изображение
width	str	Ширина изображения (по умолчанию \textwidth)