sbi-special-docx-master 25.3.4

A project for adding an information block to an MS .docx file

About

This project was created to add additional information, specified in a certain format, to existing .docx files.

Features

• DOCX Processing: Automates the editing and formatting of DOCX documents.
• Flexible Configuration: Easily customize processing parameters to suit your specific needs.
• Seamless Integration: Integrates smoothly with other services and workflows thanks to its open architecture.
• Extensibility: A clear and modular code structure allows you to add new features or modify existing ones with ease.

Table of Contents

• Installation
• Usage
• Example
• License

Installation

The project is available on the Python Package Index (PyPI), making installation simple and straightforward. To install, run:

    pip install sbi-special-docx-master

Usage

# Import the AddDocx class from the sbi_special_docx_master module
from sbi_special_docx_master import AddDocx

# Import the Document class from the python-docx library
from docx import Document

# Specify the path to the DOCX file you want to open
add_file = "Your_file.docx"

# Load the DOCX file into a Document object
doc = Document(add_file)

# Create a dictionary with the information that will be added to the document.
# This dictionary contains a list under the key 'separate_information_relations'.
# Each item in the list is a dictionary with 'content', 'images', and 'title'.
info_dict = {
    'separate_information_relations': [
        {
            'content': 'str',  # Some text content
            'images': [        # A list of images (each is a dictionary)
                {
                    'file': '<Base64>'  # Base64-encoded image string
                }
            ],
            'title': 'str'     # Title for this section
        },
        {
            'content': 'str',  # Another text content
            'images': [
                {
                    'file': int,  # This seems unusual; normally you'd expect a Base64 string here
                }
            ],
            'title': 'str'
        }
    ]
}

# Initialize the AddDocx object with the document and the provided info dictionary
spec = AddDocx(doc, info_dict)

# Save the modified document to a new file
spec.save('my_file.docx')

# Optionally, call the method to save the document content to an IO stream.
spec.save_io()

# Retrieve the modified document from the AddDocx object.
doc_ex = spec.document

# Check whether the addition operation was successful.
doc_suc = spec.has_succeeded

Example

License

This project is licensed under the MIT License – see the LICENSE file for details.