Merge pull request #385 from flying-sheep/context

Add ConTeXt support

.circleci/config.yml

@@ -17,7 +17,7 @@ jobs:
       - run: sudo apt update
       # <https://stackoverflow.com/a/44333806/353337>
       - run: DEBIAN_FRONTEND=noninteractive sudo apt install tzdata
-      - run: sudo apt install -y texlive-latex-base texlive-latex-extra
+      - run: sudo apt install -y texlive-latex-base texlive-latex-extra context
       - run: pip3 install -U pytest pytest-cov excode --user
       - checkout
       - run: excode README.md test/zzz_readme_test.py --filter python,test

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
         python-version: "3.x"
     - uses: actions/checkout@v1
     - name: Install dependencies
-      run: sudo apt-get install -y texlive-latex-base texlive-latex-extra python3-tk python3-scipy
+      run: sudo apt-get install -y texlive-latex-base texlive-latex-extra context python3-tk python3-scipy
     - name: Install package
       run: |
         pip install --upgrade pip

README.md

@@ -18,10 +18,10 @@ figures like
 
 ![](https://nschloe.github.io/tikzplotlib/example.png)
 
-for native inclusion into LaTeX documents.
+for native inclusion into LaTeX or ConTeXt documents.
 
 The output of tikzplotlib is in
-[PGFPlots](http://pgfplots.sourceforge.net/pgfplots.pdf), a LaTeX library that sits on
+[PGFPlots](http://pgfplots.sourceforge.net/pgfplots.pdf), a TeX library that sits on
 top of [PGF/TikZ](https://en.wikipedia.org/wiki/PGF/TikZ) and describes graphs in terms
 of axes, data etc. Consequently, the output of tikzplotlib
 
@@ -95,7 +95,7 @@ table {%
 ```
 (Use `get_tikz_code()` instead of `save()` if you want the code as a string.)
 
-Tweaking the plot is straightforward and can be done as part of your LaTeX work flow.
+Tweaking the plot is straightforward and can be done as part of your TeX work flow.
 [The fantastic PGFPlots manual](http://pgfplots.sourceforge.net/pgfplots.pdf) contains
 great examples of how to make your plot look even better.
 
@@ -120,10 +120,12 @@ to install/update.
     ```python
     import tikzplotlib
     tikzplotlib.save("mytikz.tex")
+    # or
+    tikzplotlib.save("mytikz.tex", flavor="context")
     ```
    to store the TikZ file as `mytikz.tex`.
 
-3. Add the contents of `mytikz.tex` into your LaTeX source code. A convenient way of
+3. Add the contents of `mytikz.tex` into your TeX source code. A convenient way of
    doing so is via
     ```latex
     \input{/path/to/mytikz.tex}
@@ -132,11 +134,29 @@ to install/update.
    included in the header of your document:
     ```latex
     \usepackage[utf8]{inputenc}
-    \usepackage{fontspec}  % optional
     \usepackage{pgfplots}
+    \DeclareUnicodeCharacter{2212}{−}
+    \usepgfplotslibrary{groupplots,dateplot}
+    \usetikzlibrary{patterns,shapes.arrows}
     \pgfplotsset{compat=newest}
-    \usepgfplotslibrary{groupplots}
-    \usepgfplotslibrary{dateplot}
+    ```
+   or:
+    ```latex
+    \setupcolors[state=start]
+    \usemodule[tikz]
+    \usemodule[pgfplots]
+    \usepgfplotslibrary[groupplots,dateplot]
+    \usetikzlibrary[patterns,shapes.arrows]
+    \pgfplotsset{compat=newest}
+    \unexpanded\def\startgroupplot{\groupplot}
+    \unexpanded\def\stopgroupplot{\endgroupplot}
+    ```
+   You can also get the code via:
+    ```python
+    import tikzplotlib
+    tikzplotlib.Flavors.latex.preamble()
+    # or
+    tikzplotlib.Flavors.context.preamble()
     ```
 
 4. Optional: clean up the figure before exporting to tikz using the `clean_figure` command.

test/helpers.py

@@ -31,11 +31,14 @@ def _unidiff_output(expected, actual):
 
 
 def assert_equality(
-    plot, filename, assert_compilation=True, **extra_get_tikz_code_args
+    plot, filename, assert_compilation=True, flavor="latex", **extra_get_tikz_code_args
 ):
     plot()
     code = tikzplotlib.get_tikz_code(
-        include_disclaimer=False, float_format=".8g", **extra_get_tikz_code_args
+        include_disclaimer=False,
+        float_format=".8g",
+        flavor=flavor,
+        **extra_get_tikz_code_args,
     )
     plt.close()
 
@@ -47,13 +50,16 @@ def assert_equality(
     if assert_compilation:
         plot()
         code = tikzplotlib.get_tikz_code(
-            include_disclaimer=False, standalone=True, **extra_get_tikz_code_args
+            include_disclaimer=False,
+            standalone=True,
+            flavor=flavor,
+            **extra_get_tikz_code_args,
         )
         plt.close()
-        assert _compile(code) is not None, code
+        assert _compile(code, flavor) is not None, code
 
 
-def _compile(code):
+def _compile(code, flavor):
     _, tmp_base = tempfile.mkstemp()
 
     tex_file = tmp_base + ".tex"
@@ -64,13 +70,14 @@ def _compile(code):
     os.chdir(os.path.dirname(tex_file))
 
     # compile the output to pdf
+    cmdline = dict(
+        latex=["pdflatex", "--interaction=nonstopmode"],
+        context=["context", "--nonstopmode"],
+    )[flavor]
     try:
-        subprocess.check_output(
-            ["pdflatex", "--interaction=nonstopmode", tex_file],
-            stderr=subprocess.STDOUT,
-        )
+        subprocess.check_output(cmdline + [tex_file], stderr=subprocess.STDOUT)
     except subprocess.CalledProcessError as e:
-        print("pdflatex output:")
+        print(f"{cmdline[0]} output:")
         print("=" * 70)
         print(e.output.decode("utf-8"))
         print("=" * 70)
@@ -81,15 +88,15 @@ def _compile(code):
     return output_pdf
 
 
-def compare_mpl_latex(plot):
+def compare_mpl_tex(plot, flavor="latex"):
     plot()
     code = tikzplotlib.get_tikz_code(standalone=True)
     directory = os.getcwd()
     filename = "test-0.png"
     plt.savefig(filename)
     plt.close()
 
-    pdf_file = _compile(code)
+    pdf_file = _compile(code, flavor)
     pdf_dirname = os.path.dirname(pdf_file)
 
     # Convert PDF to PNG.

test/test_annotate.py

@@ -44,5 +44,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_arrows.py

@@ -70,5 +70,5 @@ def to_texstring(s):
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_axvline.py

@@ -22,5 +22,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_barchart_legend.py

@@ -40,5 +40,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_basic_sin.py

@@ -29,5 +29,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_colorbars.py

@@ -81,5 +81,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_context.py

@@ -0,0 +1,20 @@
+from helpers import assert_equality
+
+
+def plot():
+    import numpy as np
+    import matplotlib.pyplot as plt
+    import matplotlib.cm as cm
+
+    x, y = np.meshgrid(np.linspace(0, 1), np.linspace(0, 1))
+    z = x ** 2 - y ** 2
+
+    fig = plt.figure()
+    plt.pcolormesh(x, y, z, cmap=cm.viridis)
+
+    return fig
+
+
+def test():
+    assert_equality(plot, __file__[:-3] + "_reference.tex", flavor="context")
+    return

test/test_context_reference.tex

@@ -0,0 +1,16 @@
+\starttikzpicture
+
+\startaxis[
+tick align=outside,
+tick pos=left,
+x grid style={white!69.019608!black},
+xmin=0, xmax=1,
+xtick style={color=black},
+y grid style={white!69.019608!black},
+ymin=0, ymax=1,
+ytick style={color=black}
+]
+\addplot graphics [includegraphics cmd=\pgfimage,xmin=0, xmax=1, ymin=0, ymax=1] {tmp-000.png};
+\stopaxis
+
+\stoptikzpicture

test/test_contourf.py

@@ -38,5 +38,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_datetime.py

@@ -26,5 +26,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_datetime_paths.py

@@ -30,4 +30,4 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)

test/test_errorband.py

@@ -26,5 +26,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_fancybox.py

@@ -204,5 +204,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_hatch.py

@@ -63,4 +63,4 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)

test/test_legend3.py

@@ -16,5 +16,5 @@ def plot():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_legend_best_location.py

@@ -67,5 +67,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_legend_line_scatter.py

@@ -22,5 +22,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_line_collection.py

@@ -56,5 +56,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_line_dashes.py

@@ -19,5 +19,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_pandas_dataframe.py

@@ -19,5 +19,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_patch_styles.py

@@ -27,5 +27,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_patches.py

@@ -90,5 +90,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_scatter.py

@@ -23,5 +23,5 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)
     # helpers.print_tree(plot())

test/test_steps.py

@@ -30,4 +30,4 @@ def test():
 if __name__ == "__main__":
     import helpers
 
-    helpers.compare_mpl_latex(plot)
+    helpers.compare_mpl_tex(plot)

tikzplotlib/__init__.py

@@ -8,8 +8,8 @@
     __status__,
     __version__,
 )
-from ._save import get_tikz_code, save
 from ._cleanfigure import clean_figure
+from ._save import Flavors, get_tikz_code, save
 
 __all__ = [
     "__author__",
@@ -21,4 +21,5 @@
     "get_tikz_code",
     "save",
     "clean_figure",
+    "Flavors",
 ]

tikzplotlib/_axes.py

@@ -146,7 +146,7 @@ def __init__(self, data, obj):  # noqa: C901
         if self.is_subplot:
             self.content.append("\n\\nextgroupplot")
         else:
-            self.content.append("\\begin{axis}")
+            self.content.append(data["flavor"].start("axis"))
 
     def get_begin_code(self):
         content = self.content
@@ -158,10 +158,10 @@ def get_begin_code(self):
 
     def get_end_code(self, data):
         if not self.is_subplot:
-            return "\\end{axis}\n\n"
+            return data["flavor"].end("axis") + "\n\n"
         elif self.is_subplot and self.nsubplots == self.subplot_index:
             data["is_in_groupplot_env"] = False
-            return "\\end{groupplot}\n\n"
+            return data["flavor"].end("groupplot") + "\n\n"
 
         return ""
 
@@ -419,7 +419,7 @@ def _subplot(self, obj, data):
                     group_style.extend(data["extra groupstyle options [base]"])
                     options = ["group style={{{}}}".format(", ".join(group_style))]
                     self.content.append(
-                        "\\begin{{groupplot}}[{}]".format(", ".join(options))
+                        data["flavor"].start("groupplot") + f"[{', '.join(options)}]"
                     )
                     data["is_in_groupplot_env"] = True
                     data["pgfplots libs"].add("groupplots")