pydocmaker 2.3.0__tar.gz → 2.3.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocmaker
-Version: 2.3.0
+Version: 2.3.2
 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.0 → pydocmaker-2.3.2}/src/pydocmaker/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '2.3.0'
+__version__ = '2.3.2'
 
 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
@@ -126,9 +126,9 @@ def mk_md(children=None, index=None, chapter=None, color='', end=None, **kwargs)
        **kwargs: Additional keyword arguments for the document part.
 
    Returns:
-       DocBuilder: A new DocBuilder object with the added markdown document part.
+       dict: The newly created markdown document part.
    """
-   return DocBuilder().add_md(children=children, index=index, chapter=chapter, color=color, end=end, **kwargs)
+   return DocBuilder().add_md(children=children, index=index, chapter=chapter, color=color, end=end, **kwargs)[0]
 
 
 def mk_pre(children=None, index=None, chapter=None, color='', end=None, **kwargs):
@@ -149,13 +149,14 @@ def mk_pre(children=None, index=None, chapter=None, color='', end=None, **kwargs
    return DocBuilder().add_pre(children=children, index=index, chapter=chapter, color=color, end=end, **kwargs)[0]
 
 
-def mk_fig(fig=None, caption='', width=0.8, children=None, color='', end=None, **kwargs):
+def mk_fig(fig=None, caption='', width=0.8, bbox_inches='tight', children=None, color='', end=None, **kwargs):
     """make an image document part from a pyplot figure type dict from given image input.
     
     Args:
         fig (matplotlib figure, optional): the figure which to upload (or the current figure if None). Defaults to None.
         caption (str, optional): the caption to give to the image. Defaults to ''.
         width (float, optional): The width for the image to have in the document. Defaults to 0.8.
+        bbox_inches (str, optional): will give better spacing for matplotlib figures.
         children (str, optional): A specific name/id to give to the image (will be auto generated if None). Defaults to None.
         index (int, optional): The index where to insert the part. If None, appends to the end.
         chapter (str | int, optional): The chapter name or index where to insert the part. If None, appends to the end.
@@ -165,7 +166,7 @@ def mk_fig(fig=None, caption='', width=0.8, children=None, color='', end=None, *
     Returns:
         dict: The created document part.
     """
-    return DocBuilder().add_fig(fig=fig, caption=caption, width=width, children=children, color=color, end=end, **kwargs)[0]
+    return DocBuilder().add_fig(fig=fig, caption=caption, width=width, bbox_inches=bbox_inches, children=children, color=color, end=end, **kwargs)[0]
 
 def mk_image(image, caption='', width=0.8, children=None, color='', end=None, **kwargs):
     """make an image type dict from given image input.

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

@@ -268,7 +268,7 @@ class constr():
         return constr.image(imageblob=imageblob, children=children, caption=caption, width=width, color=color, end=end)
         
 
-    def image_from_fig(caption='', width=0.8, children=None, fig=None, color='', end=None, **kwargs):
+    def image_from_fig(caption='', width=0.8, children=None, fig=None, color='', end=None, bbox_inches='tight', **kwargs):
         """convert a matplotlib figure (or the current figure) to a document image dict to later add to a document
 
         Args:
@@ -285,9 +285,9 @@ class constr():
 
         with io.BytesIO() as buf:
             if fig:
-                fig.savefig(buf, format='png', **kwargs)
+                fig.savefig(buf, format='png', bbox_inches=bbox_inches, **kwargs)
             else:
-                plt.savefig(buf, format='png', **kwargs)
+                plt.savefig(buf, format='png', bbox_inches=bbox_inches, **kwargs)
             buf.seek(0)   
 
             img = base64.b64encode(buf.read()).decode('utf-8')
@@ -874,22 +874,22 @@ class DocBuilder(UserList):
         return self
     
 
-    def add_fig(self, fig=None, caption = '', width=0.8, children=None, index=None, chapter=None, color='', end=None, **kwargs):
+    def add_fig(self, fig=None, caption = '', width=0.8, bbox_inches='tight', children=None, index=None, chapter=None, color='', end=None, **kwargs):
         """add a pyplot figure type dict from given image input.
         
         Args:
             fig (matplotlib figure, optional): the figure which to upload (or the current figure if None). Defaults to None.
             caption (str, optional): the caption to give to the image. Defaults to ''.
             width (float, optional): The width for the image to have in the document. Defaults to 0.8.
+            bbox_inches (str, optional): will give better spacing for matplotlib figures.
             children (str, optional): A specific name/id to give to the image (will be auto generated if None). Defaults to None.
             index (int, optional): The index where to insert the part. If None, appends to the end.
             chapter (str | int, optional): The chapter name or index where to insert the part. If None, appends to the end.
             color (str, optional): any color which can be rendered by html or latex. Empty string for default.
             end (str, optional): If you want to insert a different line ending (than the default) for this element set this argument to any string. None for default.
 
-
         """
-        self.add(constr.image_from_fig(caption=caption, width=width, children=children, fig=fig, color=color, end=end, **kwargs), index=index, chapter=chapter)
+        self.add(constr.image_from_fig(caption=caption, width=width, bbox_inches=bbox_inches, children=children, fig=fig, color=color, end=end, **kwargs), index=index, chapter=chapter)
         return self
     
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydocmaker
-Version: 2.3.0
+Version: 2.3.2
 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