Metadata-Version: 2.4
Name: html2docxconverter
Version: 0.1.8
Summary: Конвертирует HTML в DOCX с сохранением стилей: списков, таблиц, шрифтов, цветов и т.д.
Author: pew
License: MIT
Project-URL: Homepage, https://github.com/Dnnbg123/html2docxconverter
Project-URL: Repository, https://github.com/Dnnbg123/html2docxconverter
Project-URL: Bug_Tracker, https://github.com/Dnnbg123/html2docxconverter/issues
Keywords: html,docx,word,convert,parser
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-docx<1.3,>=1.2.0
Requires-Dist: beautifulsoup4>=4.14.3
Requires-Dist: soupsieve>=2.8.1
Requires-Dist: requests>=2.32.5
Requires-Dist: pillow>=12.1.0
Dynamic: license-file

# Библиотека конвертации HTML в DOCX

Python-библиотека для преобразования HTML-контента в документы Word (.docx) с поддержкой таблиц, списков, изображений и
CSS-стилей.

## Установка

```bash
pip install html2docxconverter
```

```bash
uv add html2docxconverter
```

## Поддерживаемые HTML-теги

### Основные теги

- **`<p>`** - абзацы текста
- **`<figure>`** - контейнеры для изображений
- **`<ul>`** - неупорядоченные списки
- **`<ol>`** - упорядоченные списки
- **`<li>`** - элементы списков
- **`<table>`** - таблицы
- **`<tr>`** - строки таблицы
- **`<td>`** - ячейки таблицы
- **`<th>`** - заголовочные ячейки таблицы
- **`<colgroup>`** - группировка столбцов таблицы
- **`<col>`** - определение столбца таблицы
- **`<tbody>`** - тело таблицы
- **`<img>`** - изображения (поддержка src, srcset, data URI, относительных путей)

### Теги форматирования текста

- **`<strong>`**, **`<b>`** - жирный текст
- **`<em>`**, **`<i>`** - курсив
- **`<u>`** - подчеркнутый текст
- **`<s>`**, **`<strike>`**, **`<del>`** - зачеркнутый текст
- **`<sup>`** - верхний индекс
- **`<sub>`** - нижний индекс
- **`<span>`** - контейнер для стилизации текста

## Поддерживаемые CSS-стили

### Стили текста

- **`color`** - цвет текста (имена цветов, hex, rgb)
- **`background-color`** - выделение цветом (имена цветов, hex, rgb)
- **`font-size`** - размер шрифта (px, pt, em, %)
- **`text-align`** - выравнивание текста (left, right, center, justify)
- **`vertical-align`** - вертикальное выравнивание (top, middle, bottom)

### Стили таблиц и ячеек

- **`width`** - ширина таблицы/ячейки (px, %)
- **`height`** - высота строки/ячейки (px)
- **`background-color`** - цвет фона таблицы/ячейки
- **`border`** - граница (ширина стиль цвет)
- **`border-width`** - ширина границы
- **`border-style`** - стиль границы (solid, single)
- **`border-color`** - цвет границы
- **`float`** - позиционирование таблицы (left, right)

### Стили изображений

- **`width`** — ширина изображения (px, %, em)
- **`height`** — высота изображения (px, em)
- **`aspect-ratio`** — сохранение пропорций
- **`object-fit`** — `contain`, `cover`
- **`display`** — `block`, `inline-block`
- **`float`** — `left`, `right` (обтекание текста)
- **`margin`** — внешние отступы
- **`border-radius`** — скругление углов (реализовано через маску PNG)
- **`box-shadow`** — тень (реализована через Pillow)

Дополнительно:

- поддержка **WebP → PNG**
- поддержка **srcset** (выбор лучшего изображения)
- поддержка **относительных путей** через `<base href="...">`
- автоматическое **ограничение ширины и высоты страницы**

---

## Дополнительные возможности

- Автоматическая обработка `<base href="...">` для относительных путей
- Корректная работа с вложенными списками
- Поддержка layout‑таблиц (если указан CSS‑класс)
- Поддержка многоуровневых списков
- Поддержка inline‑стилей в `<span>`
- Корректная обработка HTML‑структуры через BeautifulSoup

### За основу при создании HTML контента использовался

[CKEditor](https://ckeditor.com/)

## Пример использования при парсинге HTML

```python
from docx import Document
from htmltodocx import HTMLtoDocx

# Создание нового документа
doc = Document()

# HTML-контент для конвертации
html_content = """
<p>Это <strong>жирный</strong> и <em>курсивный</em> текст.</p>
<ul>
    <li>Первый элемент</li>
    <li>Второй элемент</li>
</ul>
"""

# Конвертация HTML в DOCX
converter = HTMLtoDocx(doc)
converted_doc = converter.parse_html(html_content)

# Сохранение документа
doc.save("output.docx")
```

## Пример использования при получении HTML страницы по url

```python
from docx import Document
from htmltodocx import HTMLtoDocx

# Создание нового документа
doc = Document()
# Получение HTML и конвертация в DOCX
converter = HTMLtoDocx(doc)
converted_doc = converter.parse_url('https://habr.com/en/news/930292/')

# Сохранение документа
doc.save("output.docx")
```

## Настройки форматирования

```python
from docx.enum.text import WD_PARAGRAPH_ALIGNMENT
from htmltodocx.schemas import ConfigSchema, DefaultTableStyleSchema, DefaultConfigSchema
from docx import Document
from htmltodocx import HTMLtoDocx

align_map = {
    "left": WD_PARAGRAPH_ALIGNMENT.LEFT,
    "center": WD_PARAGRAPH_ALIGNMENT.CENTER,
    "right": WD_PARAGRAPH_ALIGNMENT.RIGHT,
    "justify": WD_PARAGRAPH_ALIGNMENT.JUSTIFY,
}

align_image_class_map = {
    "image-style-block-align-left": WD_PARAGRAPH_ALIGNMENT.LEFT,
    "image-style-block-align-right": WD_PARAGRAPH_ALIGNMENT.RIGHT,
    "image-style-block-align-center": WD_PARAGRAPH_ALIGNMENT.CENTER,
}

vertical_align_map = {"top": "top", "middle": "center", "bottom": "bottom"}

border_side = ["top", "left", "bottom", "right"]

border_style = {
    "none": "nil",
    "solid": "single",
    "dotted": "dotted",
    "dashed": "dash",
    "double": "double",
    "groove": "threeDEmboss",
    "ridge": "threeDEngrave",
    "inset": "inset",
    "outset": "outset",
}

default_settings = DefaultConfigSchema(
    align_paragraph=WD_PARAGRAPH_ALIGNMENT.JUSTIFY,
    align_image=WD_PARAGRAPH_ALIGNMENT.CENTER,
    vertical_align='center',
    table_style=DefaultTableStyleSchema(
        width="1pt", style="single", color="000000"
    )
)

base_config = ConfigSchema(
    align_map=align_map,
    align_image_class_map=align_image_class_map,
    vertical_align_map=vertical_align_map,
    border_side=border_side,
    border_style=border_style,
    default_settings=default_settings
)
# HTML-контент для конвертации
html_content = """
<p>Это <strong>жирный</strong> и <em>курсивный</em> текст.</p>
<ul>
    <li>Первый элемент</li>
    <li>Второй элемент</li>
</ul>
"""

# Конвертация HTML в DOCX
doc = Document()
converter = HTMLtoDocx(doc, config=base_config, layout_table_class='layout-table', message_start='HTML контент: ')
converted_doc = converter.parse_html(html_content)
par = doc.add_paragraph()
par.add_run('Hello World!')
# Сохранение документа
doc.save("output.docx")
```

## Лицензия

MIT License

