tikzplotly 0.1.0__tar.gz

tikzplotly-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 @thomas-saigre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tikzplotly-0.1.0/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: tikzplotly
+Version: 0.1.0
+Summary: Convert plotly figures to LaTeX / tikz figures
+Author-email: Thomas Saigre <tikzplotly@outlook.fr>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2023 @thomas-saigre
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Code, https://github.com/thomas-saigre/tikzplotly
+Project-URL: Issues, https://github.com/thomas-saigre/tikzplotly/issues
+Keywords: plotly,latex,tikz,figure,conversion,graphics
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+![alt text](doc/img/logo.svg "Tikzplotly")
+
+# Tikzplotly
+
+Convert [plotly](https://plotly.com/python/) figures to tikz code for inclusion into [PGFPlots](https://www.ctan.org/pkg/pgfplots) ([PGF/TikZ](https://www.ctan.org/pkg/pgf)) figures.
+
+This results in a ti*k*z code, that can be easily included into your LaTeX document.
+This also allow to easily edit the content of the figure.
+
+## Example
+
+The following Python code
+
+```python
+import plotly.express as px
+import tikzplotly
+
+df = px.data.gapminder().query("country=='Canada'")
+fig = px.line(df, x="year", y="lifeExp", title='Life expectancy in Canada')
+tikzplotly.save("example.tex", fig)
+```
+
+will result in the following ti*k*z code
+
+```latex
+% This file was created with tikzplotly version 0.0.1.
+\begin{tikzpicture}
+
+\definecolor{636efa}{HTML}{636efa}
+
+\begin{axis}[
+title=Life expectancy in Canada,
+xlabel=year,
+ylabel=lifeExp,
+]
+\addplot+ [mark=none, solid, color=636efa, forget plot] table {%
+1952 68.75
+1957 69.96
+1962 71.3
+1967 72.13
+1972 72.88
+1977 74.21
+1982 75.76
+1987 76.86
+1992 77.95
+1997 78.61
+2002 79.77
+2007 80.653
+};
+\end{axis}
+\end{tikzpicture}
+```
+
+
+## Note
+
+* This module is in development and new features are added bit by bit, when needed. If you have a feature request, please open an issue with the plotly figure you want to convert and the desired output.
+You can also submit a pull request with the desired feature !
+* Some feature can result in different output between the plotly figure and the tikz figure, for instance the size of markers.
+
+
+## References
+
+* [plotly](https://plotly.com/python/)
+* [PGFPlots](https://www.ctan.org/pkg/pgfplots)
+* [PGF/TikZ](https://www.ctan.org/pkg/pgf)
+* [tikzplotlib](https://github.com/nschloe/tikzplotlib) : a similar project for matplotlib figures from which this one is inspired.
+
+
+## License
+
+This project is licensed under the MIT [License](LICENSE).

tikzplotly-0.1.0/README.md

@@ -0,0 +1,72 @@
+![alt text](doc/img/logo.svg "Tikzplotly")
+
+# Tikzplotly
+
+Convert [plotly](https://plotly.com/python/) figures to tikz code for inclusion into [PGFPlots](https://www.ctan.org/pkg/pgfplots) ([PGF/TikZ](https://www.ctan.org/pkg/pgf)) figures.
+
+This results in a ti*k*z code, that can be easily included into your LaTeX document.
+This also allow to easily edit the content of the figure.
+
+## Example
+
+The following Python code
+
+```python
+import plotly.express as px
+import tikzplotly
+
+df = px.data.gapminder().query("country=='Canada'")
+fig = px.line(df, x="year", y="lifeExp", title='Life expectancy in Canada')
+tikzplotly.save("example.tex", fig)
+```
+
+will result in the following ti*k*z code
+
+```latex
+% This file was created with tikzplotly version 0.0.1.
+\begin{tikzpicture}
+
+\definecolor{636efa}{HTML}{636efa}
+
+\begin{axis}[
+title=Life expectancy in Canada,
+xlabel=year,
+ylabel=lifeExp,
+]
+\addplot+ [mark=none, solid, color=636efa, forget plot] table {%
+1952 68.75
+1957 69.96
+1962 71.3
+1967 72.13
+1972 72.88
+1977 74.21
+1982 75.76
+1987 76.86
+1992 77.95
+1997 78.61
+2002 79.77
+2007 80.653
+};
+\end{axis}
+\end{tikzpicture}
+```
+
+
+## Note
+
+* This module is in development and new features are added bit by bit, when needed. If you have a feature request, please open an issue with the plotly figure you want to convert and the desired output.
+You can also submit a pull request with the desired feature !
+* Some feature can result in different output between the plotly figure and the tikz figure, for instance the size of markers.
+
+
+## References
+
+* [plotly](https://plotly.com/python/)
+* [PGFPlots](https://www.ctan.org/pkg/pgfplots)
+* [PGF/TikZ](https://www.ctan.org/pkg/pgf)
+* [tikzplotlib](https://github.com/nschloe/tikzplotlib) : a similar project for matplotlib figures from which this one is inspired.
+
+
+## License
+
+This project is licensed under the MIT [License](LICENSE).

tikzplotly-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tikzplotly"
+version = "0.1.0"
+description = "Convert plotly figures to LaTeX / tikz figures"
+readme = "README.md"
+authors = [{name = "Thomas Saigre", email = "tikzplotly@outlook.fr"}]
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Graphics :: Graphics Conversion",
+    "Topic :: Scientific/Engineering :: Visualization",
+]
+keywords = ["plotly", "latex", "tikz", "figure", "conversion", "graphics"]
+dependencies = [
+    "numpy",
+    "plotly"
+]
+
+[project.optional-dependencies]
+dev = ["pandas"]
+
+[project.urls]
+Code = "https://github.com/thomas-saigre/tikzplotly"
+Issues = "https://github.com/thomas-saigre/tikzplotly/issues"

tikzplotly-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tikzplotly-0.1.0/src/tikzplotly/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

tikzplotly-0.1.0/src/tikzplotly/__init__.py

@@ -0,0 +1,4 @@
+from .__about__ import __version__
+from ._save import get_tikz_code, save
+
+__all__ = ["__version__", "get_tikz_code", "save"]

tikzplotly-0.1.0/src/tikzplotly/_annotations.py

@@ -0,0 +1,82 @@
+from ._axis import Axis
+from ._tex import *
+from ._color import convert_color
+
+anchor_dict = {
+    "left": "west",
+    "right": "east",
+    "top": "north",
+    "bottom": "south",
+    "middle": "",
+    "center": "",
+    None: ""
+}
+
+
+def get_coordinates(x, y, x_ref, y_ref):
+    """Computed the coordinates of an annotation. The coordinates can be relative to the axis or absolute.
+    If only one coordinate is relative and the other is absolute, the relative coordinate is converted to absolute,
+    using the axis limits : x_return = xmin + x * (xmax - xmin) (idem for y)
+
+    Parameters
+    ----------
+    x
+        input x coordinate
+    y
+        input y coordinate
+    x_ref
+        reference of the x coordinate
+    y_ref
+        reference of the y coordinate
+
+    Returns
+    -------
+        x coordinate, y coordinate, relative (boolean indicating if the coordinates are relative to the axis)
+    """
+    if x_ref == "paper" and y_ref == "paper":
+        return x, y, True
+    elif x_ref == "paper" and y_ref != "paper":
+        x_text = "\\pgfkeysvalueof{/pgfplots/xmin} + " + str(x) + "*\\pgfkeysvalueof{/pgfplots/xmax}-" + str(x) + "*\\pgfkeysvalueof{/pgfplots/xmin}"
+        return x_text, y, False
+    elif x_ref != "paper" and y_ref == "paper":
+        y_text = "\\pgfkeysvalueof{/pgfplots/ymin} + " + str(y) + "*\\pgfkeysvalueof{/pgfplots/ymax}-" + str(y) + "*\\pgfkeysvalueof{/pgfplots/ymin}"
+        return x, y_text, False
+    else:
+        return x, y, False
+
+def str_from_annotation(annotation_list, axis: Axis, colors_set):
+    """Create a string of LaTeX code for the annotations of a figure.
+
+    Parameters
+    ----------
+    annotation_list
+        list of annotations from Plotly figure, in fig.layout.annotations
+    axis
+        Axis object previously created
+    colors_set
+        colors used in the figure, to be filled with the colors of the annotations
+
+    Returns
+    -------
+        string of LaTeX code for the annotations
+    """
+    annotation_str = ""
+    if len(annotation_list) > 0:
+        axis.add_option("clip", "false")
+    for annotation in annotation_list:
+        x_anchor = anchor_dict[annotation.xanchor]
+        y_anchor = anchor_dict[annotation.yanchor]
+        x_ref = annotation.xref
+        y_ref = annotation.yref
+        x_coordinate, y_coordinate, relative = get_coordinates(annotation.x, annotation.y, x_ref, y_ref)
+        anchor_option = f"{y_anchor} {x_anchor}".rstrip()
+
+        if anchor_option != "":
+            anchor_option = f"anchor={anchor_option}"
+        node_options = anchor_option
+        if annotation.font.color is not None:
+            color_converted = convert_color(annotation.font.color)
+            colors_set.add(color_converted[:3])
+            node_options += f", color={color_converted[0]}"
+        annotation_str += tex_add_text(x_coordinate, y_coordinate, annotation.text, options=node_options, relative=relative)
+    return annotation_str

tikzplotly-0.1.0/src/tikzplotly/_axis.py

@@ -0,0 +1,114 @@
+from ._color import convert_color
+from ._tex import tex_begin_environment
+class Axis():
+
+    def __init__(self, layout, colors_set):
+        """Initialize an Axis.
+
+        Parameters
+        ----------
+        layout
+            layout of the figure
+        colors_set
+            set of colors used in the figure, to be filled with the colors of the axis
+        """
+        self.x_label = layout.xaxis.title.text
+        self.y_label = layout.yaxis.title.text
+        self.title = layout.title.text
+        self.options = {}
+        self.environment = "axis"
+
+        if layout.xaxis.visible is False:
+            self.x_label = None
+            self.add_option("hide x axis", None)
+        if layout.yaxis.visible is False:
+            self.y_label = None
+            self.add_option("hide y axis", None)
+        
+        # Handle log axes
+        if layout.xaxis.type == "log":
+            self.add_option("xmode", "log")
+        if layout.yaxis.type == "log":
+            self.add_option("ymode", "log")
+
+        if layout.plot_bgcolor is not None:
+            bg_color = convert_color(layout.plot_bgcolor)
+            colors_set.add(bg_color[:3])
+            opacity = bg_color[3]
+            if opacity < 1:
+                self.add_option("axis background/.style", f"{{fill={bg_color[0]}, opacity={opacity}}}")
+            else:
+                self.add_option("axis background/.style", f"{{fill={bg_color[0]}}}")
+
+    def set_x_label(self, x_label):
+        """Set the x label.
+
+        Parameters
+        ----------
+        x_label
+            x label
+        """
+        self.x_label = x_label
+
+    def set_y_label(self, y_label):
+        """Set the y label.
+
+        Parameters
+        ----------
+        y_label
+            y label
+        """
+        self.y_label = y_label
+
+    def add_option(self, option, value):
+        """Add an option to the axis, to be used in the axis environment.
+
+        Parameters
+        ----------
+        option
+            name of the option
+        value
+            value of the option, can be None
+        """
+        self.options[option] = value
+
+    def open_environment(self, stack_env):
+        """Open the axis environment.
+
+        Parameters
+        ----------
+        stack_env
+            stack of environments, to be filled with the axis environment
+        """
+        return tex_begin_environment(self.environment, stack_env, options=self.get_options())
+
+
+    def get_options(self):
+        """Get options string for the axis environment.
+
+        Returns
+        -------
+            string of all options with their values
+        """
+        content = False
+        options_str = ""
+        if self.title is not None:
+            options_str += f"title={self.title},\n"
+            content = True
+        if self.x_label is not None:
+            options_str += f"xlabel={self.x_label},\n"
+            content = True
+        if self.y_label is not None:
+            options_str += f"ylabel={self.y_label},\n"
+            content = True
+        if len(self.options) > 0:
+            for option, value in self.options.items():
+                if value is None:
+                    options_str += f"{option},\n"
+                else:
+                    options_str += f"{option}={value},\n"
+            content = True
+        if content:
+            return options_str[:-1]
+        else:
+            return None