docx-parser-converter 0.5

A library for converting DOCX documents to HTML and plain text

Docx Parser and Converter 📄✨

A powerful library for converting DOCX documents into HTML and plain text, with detailed parsing of document properties and styles.

Table of Contents

• Introduction 🌟
• Project Overview 🛠️
• Key Features 🌟
• Installation 💾
• Usage 🚀
• Quick Start Guide 📖
• Examples 📚
• API Reference 📜

Introduction 🌟

Welcome to the DOCX-HTML-TXT Converter project! This library allows you to easily convert DOCX documents into HTML and plain text formats, extracting detailed properties and styles using Pydantic models.

Project Overview 🛠️

The project is structured to parse DOCX files, convert their content into structured data using Pydantic models, and provide conversion utilities to transform this data into HTML or plain text.

Key Features 🌟

• Convert DOCX documents to HTML or plain text.
• Parse and extract detailed document properties and styles.
• Structured data representation using Pydantic models.

Installation 💾

To install the library, you can use pip. (Add the pip install command manually)

pip install docx-parser-converter

Usage 🚀

Importing the Library

To start using the library, import the necessary modules:

from docx_parser_converter.docx_to_html import DocxToHtmlConverter
from docx_parser_converter.docx_to_txt import DocxToTxtConverter
from docx_parser_converter.docx_parsers.utils import read_binary_from_file_path

Quick Start Guide 📖

1. Convert to HTML:

   from docx_parser_converter.docx_to_html import DocxToHtmlConverter
   from docx_parser_converter.docx_parsers.utils import read_binary_from_file_path
   
    docx_path = "path_to_your_docx_file.docx"
    html_output_path = "output.html"
   
    docx_file_content = read_binary_from_file_path(docx_path)
   
    converter = DocxToHtmlConverter(docx_file_content, use_default_values=True)
    html_output = converter.convert_to_html()
    converter.save_html_to_file(html_output, html_output_path)
   

2. Convert to Plain Text:

   from docx_parser_converter.docx_to_txt import DocxToTxtConverter
   from docx_parser_converter.docx_parsers.utils import read_binary_from_file_path
   
    docx_path = "path_to_your_docx_file.docx"
    txt_output_path = "output.txt"
   
    docx_file_content = read_binary_from_file_path(docx_path)
   
    converter = DocxToTxtConverter(docx_file_content, use_default_values=True)
    txt_output = converter.convert_to_txt(indent=True)
    converter.save_txt_to_file(txt_output, txt_output_path)
   

Examples 📚

Original DOCX File

Converted to HTML

Converted to Plain Text

API Reference 📜

For detailed API documentation, please visit our Read the Docs page.

Enjoy using DOCX-HTML-TXT Converter! 🚀✨