tikzplot42 0.4.6__tar.gz → 0.4.7__tar.gz

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.4.6
+Version: 0.4.7
 Summary: TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax.
 Author-email: Zan Ambrozic <zan.ambrozic7@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -717,13 +717,15 @@ Alternativley, download this package and install using: `pip install [path]`, wh
 Instead of using `import matplotlib.pyplot (as plt)`, use `import tikzplot.plots (as plt)`.
 
 ## LaTeX requirements
+All required packages are automatically detected and can be printed at save using kwarg `print_requirements=True` (for standalone files, preambule is automatically added).
 - `\usepackage{tikz}`,
 - `\usepackage{pgfplots}`,
 - `\pgfplotsset{compat=1.18}` (may be lower, but compilation is not guaranteed),
 - `\usepgfplotslibrary{fillbetween}` (if you use fill-between plots),
 - `\usepgfplotslibrary{groupplots}` (recommended for best results, enabled by default, may be avoided by setting TikzConfig USE_GROUPPLOTS=False),
 - `\usepackage{xcolor}` (recommended for best colors, works without but needs change of TikzConfig USE_XCOLOR=False),
-- `\usepgfplotslibrary{polar}` required for polar axis.
+- `\usepgfplotslibrary{polar}` required for polar axis,
+- `\usetikzlibrary{patterns.meta}` for hatch patterns (available for fill_between, hist and axvspan/axhspan).
 
 Export using `plt.savefig("example_graph.tex")` (recommended) or `plt.show()`.
 Then use the generated file as `\input{example_graph.tex}`.
@@ -768,7 +770,7 @@ If axes and plot have different name for command with same effect, both are impl
 There is a limited support for built-in styles (e.g. `plt.style.use("default")`), you may also define your own style using `plt.style.set_profile()`. Currently supported features are: color cycle (hex colors sequence), line width (in pt), grid (with matplotlib kwargs), background (latex style key=value), additional settings (raw latex code for optional arguments to axis: key=value).
 
 #### Supported common **kwargs
-- `color/c` (all matplotlib formats, except color schemes which are not yet implemented),
+- `color/c`,
 - `linestyle/ls`,
 - `linewidth/ls`,
 - `fmt`,
@@ -790,6 +792,7 @@ For plot configurations (default sizes, paddings, etc.), use `from tikzplot impo
 Currently supported parameters are listed with their default values in `src/tikzplot/config.py`.
 
 ## More features coming soon...
+- bar plots,
 - more developed styles,
 - improved 3D plots (currently only basic support: plot, errorbar, fill_between, scatter, plot_wireframe, plot_surface),
 - ... 

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/README.md

@@ -15,13 +15,15 @@ Alternativley, download this package and install using: `pip install [path]`, wh
 Instead of using `import matplotlib.pyplot (as plt)`, use `import tikzplot.plots (as plt)`.
 
 ## LaTeX requirements
+All required packages are automatically detected and can be printed at save using kwarg `print_requirements=True` (for standalone files, preambule is automatically added).
 - `\usepackage{tikz}`,
 - `\usepackage{pgfplots}`,
 - `\pgfplotsset{compat=1.18}` (may be lower, but compilation is not guaranteed),
 - `\usepgfplotslibrary{fillbetween}` (if you use fill-between plots),
 - `\usepgfplotslibrary{groupplots}` (recommended for best results, enabled by default, may be avoided by setting TikzConfig USE_GROUPPLOTS=False),
 - `\usepackage{xcolor}` (recommended for best colors, works without but needs change of TikzConfig USE_XCOLOR=False),
-- `\usepgfplotslibrary{polar}` required for polar axis.
+- `\usepgfplotslibrary{polar}` required for polar axis,
+- `\usetikzlibrary{patterns.meta}` for hatch patterns (available for fill_between, hist and axvspan/axhspan).
 
 Export using `plt.savefig("example_graph.tex")` (recommended) or `plt.show()`.
 Then use the generated file as `\input{example_graph.tex}`.
@@ -66,7 +68,7 @@ If axes and plot have different name for command with same effect, both are impl
 There is a limited support for built-in styles (e.g. `plt.style.use("default")`), you may also define your own style using `plt.style.set_profile()`. Currently supported features are: color cycle (hex colors sequence), line width (in pt), grid (with matplotlib kwargs), background (latex style key=value), additional settings (raw latex code for optional arguments to axis: key=value).
 
 #### Supported common **kwargs
-- `color/c` (all matplotlib formats, except color schemes which are not yet implemented),
+- `color/c`,
 - `linestyle/ls`,
 - `linewidth/ls`,
 - `fmt`,
@@ -88,6 +90,7 @@ For plot configurations (default sizes, paddings, etc.), use `from tikzplot impo
 Currently supported parameters are listed with their default values in `src/tikzplot/config.py`.
 
 ## More features coming soon...
+- bar plots,
 - more developed styles,
 - improved 3D plots (currently only basic support: plot, errorbar, fill_between, scatter, plot_wireframe, plot_surface),
 - ... 

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tikzplot42"
-version = "0.4.6"
+version = "0.4.7"
 description = "TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax."
 authors = [
     { name = "Zan Ambrozic", email = "zan.ambrozic7@gmail.com" }

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot/axes.py

@@ -147,6 +147,7 @@ class BaseAxes:
                 else:
                     return None
         assert self._fig is not None
+        self._fig._add_required_package("\\usepgfplotslibrary{fillbetween}")
         name1 = self._fig._get_free_path_name()
         name2 = self._fig._get_free_path_name()
         if isinstance(y1, (int, float)):
@@ -1002,6 +1003,8 @@ class Axes(BaseAxes):
     def _to_tex(self, filename, single):
         lines = []
         lines2 = []
+        if self._polar:
+            self._fig._add_required_package("\\usepgfplotslibrary{polar}")
         if self._polar and TikzConfig.USE_GROUPPLOTS and not single:
             lines.append(f"\\nextgroupplot[alias={self._axis_options['alias']}, width={self._width}, height={self._height}, hide axis]")
             lines2.append("\\begin{polaraxis}")

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot/elements.py

@@ -173,6 +173,7 @@ class BaseGraph:
             opts["color"] = f"{{{match_color(f'C{self._axes._get_defcol()}')}}}"
 
         if "hatch" in self._style:
+            self._axes._fig._add_required_package("\\usetikzlibrary{patterns.meta}")
             def match_hatch(input):
                 chars = list(input)
                 hatches = []

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot/figure.py

@@ -37,6 +37,8 @@ class Figure:
 
         self._lims = {"xmin": {}, "xmax": {}, "ymin": {}, "ymax": {}}
 
+        self._required_packages: dict[str, int] = {} # int for priority: 0-tikz, 1-pgfplots, 2-other packages, 3-pgfplotsset, 4-tikzlibraries, 5-pgfplotslibraries
+
     def add_subplot(self, nrows=1, ncols=1, index=1, sharex=None, sharey=None, projection=None, polar=False):
         if projection=="3d":
             ax = Axes3(nrows, ncols, index, self)
@@ -261,32 +263,13 @@ class Figure:
         for ax in self._axes:
             ax._reduce_points(limit)
 
-    def _to_tex(self, filename, png=False):
+    def _to_tex(self, filename, png=False, standalone=None, print_requirements=False):
         single = self._nrows * self._ncols == 1
         if not self._axes:
             return ""
         self._shared_ranges()
         if TikzConfig.REDUCE_NUM_POINTS:
             self._reduce_points()
-        preambule = ""
-        if TikzConfig.STANDALONE:
-            if png:
-                preambule += "\\documentclass[tikz,border=2pt,convert={density=300,outext=.png}]{standalone}\n"
-            else:
-                preambule += "\\documentclass[tikz,border=2pt]{standalone}\n"
-            preambule += "\\usepackage{tikz}\n"
-            preambule += "\\usepackage{pgfplots}\n"
-            if TikzConfig.USE_GROUPPLOTS and not single:
-                preambule += "\\usepgfplotslibrary{groupplots}\n"
-            preambule += "\\usepgfplotslibrary{fillbetween}\n"
-            preambule += "\\usepgfplotslibrary{polar}\n"
-            preambule += f"\\pgfplotsset{{compat={TikzConfig.TIKZ_COMPAT}}}\n"
-            if TikzConfig.USE_XCOLOR:
-                preambule += "\\usepackage{xcolor}\n"
-            if self._spies:
-                 preambule += "\\usetikzlibrary{spy}\n"
-            preambule += "\\begin{document}\n"
-            
         lines0 = [g for g in self._globals]
         lines = []
         lines2 = []
@@ -319,8 +302,23 @@ class Figure:
         for c in self._col_dict:
             r,g,b=self._col_dict[c]
             lines0.insert(1,f"\\definecolor{{{c}}}{{rgb}}{{{r:.3f}, {g:.3f}, {b:.3f}}}")
+        preambule = ""
+        stdalone = TikzConfig.STANDALONE if standalone is None else standalone
+        if stdalone:
+            if png:
+                preambule += "\\documentclass[tikz,border=2pt,convert={density=300,outext=.png}]{standalone}\n"
+            else:
+                preambule += "\\documentclass[tikz,border=2pt]{standalone}\n"
+            self._check_required_packages()
+            preambule += "\n".join(self._required_packages.keys()) + "\n"
+            preambule += "\\begin{document}\n"
+        if print_requirements and not stdalone:
+            self._check_required_packages()
+            print("Required packages:")
+            for p in self._required_packages.keys():
+                print(p)
         fin = ""
-        if TikzConfig.STANDALONE:
+        if stdalone:
             fin += "\\end{document}"
         for k in self._lims.keys():
             for j in self._lims[k]:
@@ -329,8 +327,8 @@ class Figure:
         output = preambule + "\n" + "\n".join(lines) + "\n" + fin
         return output
 
-    def _save(self, filename):
-        content = self._to_tex(filename)
+    def _save(self, filename, standalone=None, print_requirements=False):
+        content = self._to_tex(filename, png=False, standalone=standalone, print_requirements=print_requirements)
         if not TikzConfig.SAVE_DATAPOINTS or (TikzConfig.SAVE_DATAPOINTS and not TikzConfig.UPDATE_DATA_ONLY):
             with open(filename, "w", encoding="utf-8") as f:
                 f.write(content)
@@ -370,3 +368,29 @@ class Figure:
 
     def tight_layout(self):
         pass
+
+    def _add_required_package(self, package):
+        if package not in self._required_packages:
+            if package.startswith("\\usepackage"):
+                self._required_packages[package] = 2
+            elif package.startswith("\\pgfplotsset"):
+                self._required_packages[package] = 3
+            elif package.startswith("\\usetikzlibrary"):
+                self._required_packages[package] = 4
+            elif package.startswith("\\usepgfplotslibrary"):
+                self._required_packages[package] = 5
+            else:
+                self._required_packages[package] = 6
+
+    def _check_required_packages(self):
+        single = self._nrows * self._ncols == 1
+        self._required_packages["\\usepackage{tikz}"] = 0
+        self._required_packages["\\usepackage{pgfplots}"] = 1
+        if TikzConfig.USE_GROUPPLOTS and not single:
+            self._required_packages["\\usepgfplotslibrary{groupplots}"] = 5
+        self._required_packages[f"\\pgfplotsset{{compat={TikzConfig.TIKZ_COMPAT}}}"] = 3
+        if TikzConfig.USE_XCOLOR:
+            self._required_packages["\\usepackage{xcolor}"] = 2
+        if self._spies:
+            self._required_packages["\\usetikzlibrary{spy}"] = 4
+        self._required_packages = dict(sorted(self._required_packages.items(), key=lambda item: item[1]))

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot/figure.pyi

@@ -58,8 +58,8 @@ class Figure:
     def _shared_ranges(self) -> None: ...
     def _add_spy(self, zoom: float, size: float, **kwargs) -> int: ...
     def _reduce_points(self) -> None: ...
-    def _to_tex(self, filename: str, png: Optional[bool]=False) -> str: ...
-    def _save(self, filename: str) -> None: ...
+    def _to_tex(self, filename: str, png: Optional[bool]=False, standalone: None | bool=None, print_requirements: bool=False) -> str: ...
+    def _save(self, filename: str, standalone: None | bool=None, print_requirements: bool=False) -> None: ...
     def _save_image(self, filename: str) -> None: ...
     def _get_width(self) -> float | None: ...
     def _get_height(self) -> float | None: ...
@@ -80,3 +80,5 @@ class Figure:
         Placeholder; spacings are set in TikzConfig.
         """
         ...
+    def _add_required_package(self, package: str) -> None: ...
+    def _check_required_packages(self) -> None: ...

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot/plots.py

@@ -258,7 +258,7 @@ def yscale( *args, **kwargs):
     assert _current_axes
     _current_axes.set_yscale(*args, **kwargs)
 
-def savefig(filename):
+def savefig(filename, standalone=None, print_requirements=False):
     _im = False
     if filename.endswith(".png"):
         if not TikzConfig.STANDALONE:
@@ -273,11 +273,11 @@ def savefig(filename):
     if _im:
         _current_figure._save_image(filename)
     else:
-        _current_figure._save(filename)
+        _current_figure._save(filename, standalone=standalone, print_requirements=print_requirements)
 
-def show():
+def show(standalone=None, print_requirements=False):
     assert _current_figure
-    _current_figure._save(f"{str(main_name()[1]).removesuffix('.py')}_{TikzConfig.SHOW_SAVENAME}{next_show_num()}.tex")
+    _current_figure._save(f"{str(main_name()[1]).removesuffix('.py')}_{TikzConfig.SHOW_SAVENAME}{next_show_num()}.tex", standalone=standalone, print_requirements=print_requirements)
     clf()
 
 def clf():

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot/plots.pyi

@@ -881,18 +881,36 @@ def minorticks_num(self, num: int) -> None:
         Number of minor ticks between major ticks.
     """
 
-def savefig(filename: str) -> None:
+def savefig(filename: str, standalone: None | bool = None, print_requirements: bool = False) -> None:
     """
     Save figure to .tex/.tikz file.
 
     If no suitable extension is provided, '.tex' is appended. If using .png extension, the code generated will compile to a .png image.
+
+    Parameters
+    ----------
+    filename: str
+        Name of the file to save the figure to. If no suitable extension is provided, '.tex' is appended. If using .png extension, the code generated will compile to a .png image.
+
+    standalone: bool, optional
+        If True, the generated .tex file will be a standalone document. If False, it will be a fragment that can be included in another document. If None (default), the behavior is determined by the global setting `TikzConfig.STANDALONE`.
+
+    print_requirements: bool, optional
+        If True, the required LaTeX packages will be printed to the console. Inhibited for standalone.
     """
     ...
 
-def show() -> None:
+def show(standalone: None | bool = None, print_requirements: bool = False) -> None:
     """
     Save figure to autogenerated filename and clear it.
-    """
+
+    Parameters
+    ----------
+    standalone: bool, optional
+        If True, the generated .tex file will be a standalone document. If False, it will be a fragment that can be included in another document. If None (default), the behavior is determined by the global setting `TikzConfig.STANDALONE`.
+    
+    print_requirements: bool, optional
+        If True, the required LaTeX packages will be printed to the console. Inhibited for standalone."""
     ...
 
 def clf() -> None:

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/src/tikzplot42.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.4.6
+Version: 0.4.7
 Summary: TikzPlot to make TikZ/PGFPlots plots with matplotlib.pyplot-like syntax.
 Author-email: Zan Ambrozic <zan.ambrozic7@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -717,13 +717,15 @@ Alternativley, download this package and install using: `pip install [path]`, wh
 Instead of using `import matplotlib.pyplot (as plt)`, use `import tikzplot.plots (as plt)`.
 
 ## LaTeX requirements
+All required packages are automatically detected and can be printed at save using kwarg `print_requirements=True` (for standalone files, preambule is automatically added).
 - `\usepackage{tikz}`,
 - `\usepackage{pgfplots}`,
 - `\pgfplotsset{compat=1.18}` (may be lower, but compilation is not guaranteed),
 - `\usepgfplotslibrary{fillbetween}` (if you use fill-between plots),
 - `\usepgfplotslibrary{groupplots}` (recommended for best results, enabled by default, may be avoided by setting TikzConfig USE_GROUPPLOTS=False),
 - `\usepackage{xcolor}` (recommended for best colors, works without but needs change of TikzConfig USE_XCOLOR=False),
-- `\usepgfplotslibrary{polar}` required for polar axis.
+- `\usepgfplotslibrary{polar}` required for polar axis,
+- `\usetikzlibrary{patterns.meta}` for hatch patterns (available for fill_between, hist and axvspan/axhspan).
 
 Export using `plt.savefig("example_graph.tex")` (recommended) or `plt.show()`.
 Then use the generated file as `\input{example_graph.tex}`.
@@ -768,7 +770,7 @@ If axes and plot have different name for command with same effect, both are impl
 There is a limited support for built-in styles (e.g. `plt.style.use("default")`), you may also define your own style using `plt.style.set_profile()`. Currently supported features are: color cycle (hex colors sequence), line width (in pt), grid (with matplotlib kwargs), background (latex style key=value), additional settings (raw latex code for optional arguments to axis: key=value).
 
 #### Supported common **kwargs
-- `color/c` (all matplotlib formats, except color schemes which are not yet implemented),
+- `color/c`,
 - `linestyle/ls`,
 - `linewidth/ls`,
 - `fmt`,
@@ -790,6 +792,7 @@ For plot configurations (default sizes, paddings, etc.), use `from tikzplot impo
 Currently supported parameters are listed with their default values in `src/tikzplot/config.py`.
 
 ## More features coming soon...
+- bar plots,
 - more developed styles,
 - improved 3D plots (currently only basic support: plot, errorbar, fill_between, scatter, plot_wireframe, plot_surface),
 - ... 

{tikzplot42-0.4.6 → tikzplot42-0.4.7}/tests/test2.py

@@ -21,4 +21,4 @@ ax1.set_xlabel(r"$x$")
 ax1.set_ylabel(r"$y$")
 ax2.grid(which="both")
 
-plt.savefig("figure.tex")
+plt.savefig("figure.tex", print_requirements=True)