py-docx-creator 0.1.4.8

PyDocxCreator — это мой небольшой Python-проект для создания и форматирования Word-документов...

PDC

PyDocxCreator — это мой небольшой Python-проект для создания и форматирования Word-документов с использованием библиотеки python-docx. Вы можете дополнять и расширять ее при необходимости. Я постарался построить гибкую основу для последующего расширения.

Возможности

• Абстрактные классы для описания стилей документа, абзацев и текста.
• Реализация базовых стилей и логики генерации Word-документов.
• Гибкая настройка шрифтов, отступов, выравнивания и др.

Структура проекта

• py_docx_creator/ — модуль с основными и абстрактными классами:
  • AbstractClasses.py — абстрактные интерфейсы
  • CoreClasses.py — реализация базовых стилей
  • CustomClasses.py — расширение с пользовательскими стилями

Установка

pip install py_docx_creator

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

from py_docx_creator.AbstractClasses import AlignParagraph
from py_docx_creator.CoreClasses import CoreDocumentCreator, CoreStyleManager
from py_docx_creator.CustomClasses import MainPageStyle, MainTextStyle, HeaderParagraphStyle, \
    MainParagraphStyle, HeaderTextStyle, FastWriter


class DocumentAPI(CoreDocumentCreator):

    def __init__(self, file_name: str):
        super().__init__()
        self.file_name = file_name
        self.style_manager = CoreStyleManager
        self.write_to_document = FastWriter
        self.create_document(self.file_name)

    def run(self):
        self.style_manager.PAGE_STYLE_MANAGER.apply_style(self.document, MainPageStyle)

        self.write_to_document.write(document=self.document,
                                     text="Заголовок документа",
                                     text_style=HeaderTextStyle,
                                     paragraph_style=HeaderParagraphStyle,
                                     italic=True, 
                                     size=24)

        self.write_to_document.write(document=self.document,
                                     text="Основной текст 1",
                                     text_style=MainTextStyle,
                                     paragraph_style=MainParagraphStyle)

        self.write_to_document.write(document=self.document,
                                     text="Основной текст 2",
                                     text_style=MainTextStyle,
                                     paragraph_style=MainParagraphStyle, 
                                     alignment=AlignParagraph.RIGHT)

        self.save_document()


if __name__ == '__main__':
    DocumentAPI("Документ.docx").run()

Пример создания собственных стилей

Стоит внимательно отнестись к типизации данных так как иначе поля Вашего dataclass будут проигнорированы, а вместо них будут использоваться значения из родительского класса.

1. Создания стиля для параграфа

Пример создание собственного стиля параграфа на основе базового класса CoreParagraphStyle.

from dataclasses import dataclass

from py_docx_creator.CoreClasses import CoreParagraphStyle
from py_docx_creator.AbstractClasses import AlignParagraph
from docx.shared import Pt, Inches

@dataclass
class YourClass(CoreParagraphStyle):
    alignment: AlignParagraph | None    = None      # выравнивание                      |   AlignParagraph.*.value
    space_after: float | None              = None      # отступ до параграфа               |   Pt(int) 
    space_before: float | None             = None      # отступ после параграфа            |   Pt(int) 
    left_indent: float | None          = None      # отступ от левого края             |   Inches(float | int) 
    right_indent: float | None         = None      # отступ от правого края            |   Inches(float | int) 
    line_spacing: float | None          = None      # межстрочный интервал              |   float
    first_line_indent: float | None        = None      # отступ красной строки             |   Pt(int) 
    page_break_before: bool | None      = None      # разрыв страницы перед параграфом  |   bool

Поля, которые изменяться не будут указывать не нужно (исключить из dataclass).

2. Создание стиля для текста

Пример создания стиля текста на основе базового класса CoreTextStyle.

from dataclasses import dataclass

from py_docx_creator.CoreClasses import CoreTextStyle


@dataclass
class YourClass(CoreTextStyle):
    size: float | None               = None      # размер шрифта текста          | float
    name: str | None                 = None      # наименование шрифта              | str | FontNames.*.value
    bold: bool | None                = None      # жирное начертание шрифта         | bool
    italic: bool | None              = None      # курсивное начертание шрифта      | bool
    underline: bool | None           = None      # подчеркнутое начертание шрифта   | bool

Поля, которые изменяться не будут указывать не нужно (исключить из dataclass).

3. Создание стиля страниц документа

Пример создания стиля страниц документа на основе базового класса CorePageStyle.

from dataclasses import dataclass

from py_docx_creator.CoreClasses import CorePageStyle
from docx.shared import Pt

@dataclass
class YourClass(CorePageStyle):
    top_margin: float | None        = None   # отступ сверху   | float
    bottom_margin: float | None     = None   # отступ снизу    | float
    left_margin: float | None       = None   # отступ слева    | float
    right_margin: float | None      = None   # отступ справа   | float

Поля, которые изменяться не будут указывать не нужно (исключить из dataclass).

На данный момент доступно несколько заранее прописанных стилей

1. MainPageStyle - стиль страниц документа с заданными полями;
2. MainParagraphStyle - стиль параграфа для основного текста (текст по ширине, красная строка и др.);
3. HeaderParagraphStyle - стиль параграфа для заголовков (текст по центру);

Проект находится в активной разработке.

IN PROGRESS:

[████████████░░░░░░░░░░░░░░░░░░░░░░░░] 25%