pydocmaker 2.3.2__tar.gz → 2.3.3__tar.gz

{pydocmaker-2.3.2/src/pydocmaker.egg-info → pydocmaker-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocmaker
-Version: 2.3.2
+Version: 2.3.3
 Summary: a minimal document maker to make docx, markdown, html, textile, redmine, and tex documents from python. Written in pure python.
 Home-page: https://github.com/TobiasGlaubach/pydocmaker
 Author: Tobias Glaubach

{pydocmaker-2.3.2 → pydocmaker-2.3.3}/src/pydocmaker/__init__.py

@@ -1,9 +1,9 @@
-__version__ = '2.3.2'
+__version__ = '2.3.3'
 
 from pydocmaker.core import DocBuilder, construct, constr, buildingblocks, print_to_pdf, get_latex_compiler, set_latex_compiler, make_pdf_from_tex, show_pdf
 from pydocmaker.util import upload_report_to_redmine, bcolors, txtcolor, colors_dc
 
-
+from pydocmaker.backend.ex_docx import edit_docx_xml
 from pydocmaker.backend.ex_tex import can_run_pandoc
 from pydocmaker.backend.pdf_maker import get_all_installed_latex_compilers, get_latex_compiler
 from pydocmaker.backend.pandoc_api import pandoc_convert_file, pandoc_set_allowed

{pydocmaker-2.3.2 → pydocmaker-2.3.3}/src/pydocmaker/backend/ex_docx.py

@@ -10,6 +10,10 @@ from docx.shared import Inches, Pt
 import tempfile
 import os
 
+from pathlib import Path
+import zipfile, os, sys
+from io import BytesIO
+
 import markdown
 
 try:
@@ -32,6 +36,57 @@ except Exception as err:
 
 
 
+
+
+def edit_docx_xml(file_path, replace_dict, output_file_or_buffer=None):
+    """
+    Edit raw XML content of a DOCX file by replacing specified strings in all XML files within the document.
+
+    This function reads a DOCX file, extracts its contents (which are stored as a ZIP archive),
+    searches for specific strings in all XML files inside the archive, replaces them with new values,
+    and writes the modified content back into a new DOCX file or returns it as bytes.
+    Args:
+        file_path (str): Path to the input DOCX file to be modified
+        replace_dict (dict): Dictionary mapping strings to be replaced (keys) to their replacement values (values)
+        output_file_or_buffer (str, Path, or buffer object, optional): Path to save the modified DOCX file, or a buffer object to write to. If None, returns the modified DOCX content as bytes.
+    Returns:
+        bool or bytes: If output_file_or_buffer is a path, returns True if successful. If output_file_or_buffer is a buffer or None, returns the modified DOCX content as bytes.
+    """
+    # Read the original DOCX file
+    with open(file_path, 'rb') as f:
+        docx_data = f.read()
+    
+    # Create a temporary zip file from the DOCX data
+    zip_buffer = BytesIO(docx_data)
+    with zipfile.ZipFile(zip_buffer, 'r') as zip_file:
+        # Get all file names in the archive
+        file_list = zip_file.namelist()
+
+        output_buffer = BytesIO()
+        with zipfile.ZipFile(output_buffer, 'w', zipfile.ZIP_DEFLATED) as new_zip:
+            # Process each file in the original zip
+            for filename in file_list:
+                # Read the file content
+                content = zip_file.read(filename)
+                
+                for key_to_replace, new_value in replace_dict.items():
+                    content = content.replace(key_to_replace.encode('utf-8'), new_value.encode('utf-8'))
+                
+                # Add file to new zip
+                new_zip.writestr(filename, content)
+            # Create a new zip file in memory
+    
+    if isinstance(output_file_or_buffer, (str, Path)):
+        os.makedirs(os.path.dirname(output_file_or_buffer), exist_ok=True)
+        with open(output_file_or_buffer, 'wb') as output_buffer:
+            output_buffer.write(output_buffer.getvalue())
+        return os.path.exists(output_file_or_buffer)
+    elif hasattr(output_file_or_buffer, 'write'):
+        return output_buffer.write(output_buffer.getvalue())
+    else:
+        return output_buffer.getvalue()
+
+
 def blue(run):
     run.font.color.rgb = docx.shared.RGBColor(0, 0, 255)
 
@@ -51,12 +106,12 @@ def convert_pandoc(doc:List[dict]) -> bytes:
         with open(docx_file_path, 'rb') as fp:
             return fp.read()
         
-def convert(doc:List[dict]) -> bytes:
+def convert(doc:List[dict], template_path:str=None, make_blue=False) -> bytes:
 
-    if can_run_pandoc():
+    if can_run_pandoc() and not template_path:
         return convert_pandoc(doc)
     else:
-        renderer = docx_renderer()
+        renderer = docx_renderer(template_path, make_blue=make_blue)
         renderer.digest(doc)
         return renderer.doc_to_bytes()
 

{pydocmaker-2.3.2 → pydocmaker-2.3.3}/src/pydocmaker/backend/pandoc_api.py

@@ -71,6 +71,26 @@ def pandoc_set_allowed(is_allowed):
     allow_pandoc = True if is_allowed else False
     return allow_pandoc
 
+def pandoc_merge_files(inp_files, out_file):
+    """
+    Convert a file using pandoc.
+
+    Parameters:
+    inp_files (List[str]): The path to the input file.
+    out_file (str or Path): The path to the output file or the desired output format.
+
+    Returns:
+    subprocess.CompletedProcess: The result of the pandoc conversion command.
+
+    Raises:
+    AssertionError: If the input file does not exist or if no output file or format is provided.
+    """
+    for inp_file in inp_files:
+      assert inp_file, "Need to give an input file name!"
+      assert os.path.exists(inp_file), f"input file {inp_file=} does not exist!"
+
+    assert out_file, "Need to give an output file name!"
+    return subprocess.run(['pandoc', *inp_files, '-o', out_file])
     
 def pandoc_convert_file(inp_file, out_file_or_format):
     """
@@ -89,7 +109,7 @@ def pandoc_convert_file(inp_file, out_file_or_format):
     AssertionError: If the input file does not exist or if no output file or format is provided.
     """
     
-    assert inp_file, "Need to give an inout file name!"
+    assert inp_file, "Need to give an input file name!"
     assert os.path.exists(inp_file), f"input file {inp_file=} does not exist!"
 
     out_file = out_file_or_format

{pydocmaker-2.3.2 → pydocmaker-2.3.3}/src/pydocmaker/core.py

@@ -986,17 +986,20 @@ class DocBuilder(UserList):
         """
         return self._ret(to_markdown(self.dump(), embed_images=embed_images), path_or_stream)
 
-    def to_docx(self, path_or_stream=None) -> bytes:
+    def to_docx(self, path_or_stream=None, template_path:str=None, make_blue=False) -> bytes:
         """
         Converts the current object to a DOCX file.
 
         Args:
             path_or_stream (str or io.IOBase, optional): The path to save the file to, or a file-like object to write the data to. If not provided, the data will be returned as string.
+            template_path (str, optional): Path to a template file to use for formatting the DOCX output (will append to the end of the document).
+            make_blue (bool): If True, applies blue color styling to the generated document.
+
 
         Returns:
             bytes: The data as bytes, or True if the data was saved successfully to a file or stream.
         """
-        return self._ret(to_docx(self.dump()), path_or_stream)        
+        return self._ret(to_docx(self.dump(), template_path=template_path, make_blue=make_blue), path_or_stream)        
     
     def to_ipynb(self, path_or_stream=None) -> str:
         """

{pydocmaker-2.3.2 → pydocmaker-2.3.3/src/pydocmaker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocmaker
-Version: 2.3.2
+Version: 2.3.3
 Summary: a minimal document maker to make docx, markdown, html, textile, redmine, and tex documents from python. Written in pure python.
 Home-page: https://github.com/TobiasGlaubach/pydocmaker
 Author: Tobias Glaubach