tikzplotly 0.2.0__tar.gz → 0.2.1__tar.gz

{tikzplotly-0.2.0 → tikzplotly-0.2.1}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: tikzplotly
-Version: 0.2.0
-Summary: Convert plotly figures to LaTeX / tikz figures
+Version: 0.2.1
+Summary: Convert plotly figures to LaTeX / TikZ figures
 Author-email: Thomas Saigre <tikzplotly@outlook.fr>
 License: The MIT License (MIT)
         
@@ -46,6 +46,7 @@ Requires-Dist: plotly
 Requires-Dist: pillow
 Provides-Extra: dev
 Requires-Dist: pandas; extra == "dev"
+Dynamic: license-file
 
 ![logo-tikzplotly](https://raw.githubusercontent.com/thomas-saigre/tikzplotly/main/docs/assets/logo.svg "Tikzplotly")
 
@@ -57,17 +58,20 @@ Requires-Dist: pandas; extra == "dev"
 
 [![GitHub release](https://img.shields.io/github/release/thomas-saigre/tikzplotly.svg?style=flat-square)](https://github.com/thomas-saigre/tikzplotly/releases)
 [![Issue](https://img.shields.io/github/issues-raw/thomas-saigre/tikzplotly?style=flat-square)](https://github.com/thomas-saigre/tikzplotly/issues)
-[![codecov](https://img.shields.io/codecov/c/github/thomas-saigre/tikzplotly.svg?style=flat-square)](https://codecov.io/gh/thomas-saigre/tikzplotly)
+[![codecov](https://img.shields.io/codecov/c/github/thomas-saigre/tikzplotly?token=NH7GAHLBLE&style=flat-square&logo=codecov
+)](https://codecov.io/gh/thomas-saigre/tikzplotly)
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/thomas-saigre/tikzplotly/ci.yml?style=flat-square)
 
 
 # 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.
+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 allows to easily edit the content of the figure.
 
+More details can be found in [the documentation](https://thomas-saigre.github.io/tikzplotly/).
+
 ## Example
 
 The following Python code
@@ -84,7 +88,8 @@ tikzplotly.save("example.tex", fig)
 will result in the following ti*k*z code
 
 ```latex
-\pgfplotstableread{data0 Australia New_Zealand
+\pgfplotstableread{
+x Australia NewZealand
 1952 69.12 69.39
 1957 70.33 70.26
 1962 70.93 71.24
@@ -97,7 +102,7 @@ will result in the following ti*k*z code
 1997 78.83 77.55
 2002 80.37 79.11
 2007 81.235 80.204
-}\dataZ
+}\dataA
 
 \begin{tikzpicture}
 
@@ -106,11 +111,11 @@ will result in the following ti*k*z code
 
 \begin{axis}[
 xlabel=year,
-ylabel=lifeExp,
+ylabel=lifeExp
 ]
-\addplot+ [mark=*, solid, color=636efa, mark options={solid, draw=636efa}] table[y=Australia] {\dataZ};
+\addplot+ [mark=*, solid, color=636efa] table[y=Australia] {\dataA};
 \addlegendentry{Australia}
-\addplot+ [mark=*, solid, color=EF553B, mark options={solid, draw=EF553B}] table[y=New_Zealand] {\dataZ};
+\addplot+ [mark=*, solid, color=EF553B] table[y=NewZealand] {\dataA};
 \addlegendentry{New Zealand}
 \end{axis}
 \end{tikzpicture}
@@ -148,7 +153,7 @@ To correctly compile the document, you will need to add the following packages t
 
 * 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, more details can be found in the documentation.
+* Some feature can result in different output between the plotly figure and the TikZ figure, for instance the size of markers, more details can be found in [the documentation](https://thomas-saigre.github.io/tikzplotly/).
 
 
 ## References

{tikzplotly-0.2.0 → tikzplotly-0.2.1}/README.md

@@ -8,17 +8,20 @@
 
 [![GitHub release](https://img.shields.io/github/release/thomas-saigre/tikzplotly.svg?style=flat-square)](https://github.com/thomas-saigre/tikzplotly/releases)
 [![Issue](https://img.shields.io/github/issues-raw/thomas-saigre/tikzplotly?style=flat-square)](https://github.com/thomas-saigre/tikzplotly/issues)
-[![codecov](https://img.shields.io/codecov/c/github/thomas-saigre/tikzplotly.svg?style=flat-square)](https://codecov.io/gh/thomas-saigre/tikzplotly)
+[![codecov](https://img.shields.io/codecov/c/github/thomas-saigre/tikzplotly?token=NH7GAHLBLE&style=flat-square&logo=codecov
+)](https://codecov.io/gh/thomas-saigre/tikzplotly)
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/thomas-saigre/tikzplotly/ci.yml?style=flat-square)
 
 
 # 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.
+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 allows to easily edit the content of the figure.
 
+More details can be found in [the documentation](https://thomas-saigre.github.io/tikzplotly/).
+
 ## Example
 
 The following Python code
@@ -35,7 +38,8 @@ tikzplotly.save("example.tex", fig)
 will result in the following ti*k*z code
 
 ```latex
-\pgfplotstableread{data0 Australia New_Zealand
+\pgfplotstableread{
+x Australia NewZealand
 1952 69.12 69.39
 1957 70.33 70.26
 1962 70.93 71.24
@@ -48,7 +52,7 @@ will result in the following ti*k*z code
 1997 78.83 77.55
 2002 80.37 79.11
 2007 81.235 80.204
-}\dataZ
+}\dataA
 
 \begin{tikzpicture}
 
@@ -57,11 +61,11 @@ will result in the following ti*k*z code
 
 \begin{axis}[
 xlabel=year,
-ylabel=lifeExp,
+ylabel=lifeExp
 ]
-\addplot+ [mark=*, solid, color=636efa, mark options={solid, draw=636efa}] table[y=Australia] {\dataZ};
+\addplot+ [mark=*, solid, color=636efa] table[y=Australia] {\dataA};
 \addlegendentry{Australia}
-\addplot+ [mark=*, solid, color=EF553B, mark options={solid, draw=EF553B}] table[y=New_Zealand] {\dataZ};
+\addplot+ [mark=*, solid, color=EF553B] table[y=NewZealand] {\dataA};
 \addlegendentry{New Zealand}
 \end{axis}
 \end{tikzpicture}
@@ -99,7 +103,7 @@ To correctly compile the document, you will need to add the following packages t
 
 * 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, more details can be found in the documentation.
+* Some feature can result in different output between the plotly figure and the TikZ figure, for instance the size of markers, more details can be found in [the documentation](https://thomas-saigre.github.io/tikzplotly/).
 
 
 ## References

{tikzplotly-0.2.0 → tikzplotly-0.2.1}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tikzplotly"
-version = "0.2.0"
-description = "Convert plotly figures to LaTeX / tikz figures"
+version = "0.2.1"
+description = "Convert plotly figures to LaTeX / TikZ figures"
 readme = "README.md"
 authors = [{name = "Thomas Saigre", email = "tikzplotly@outlook.fr"}]
 license = { file = "LICENSE" }

tikzplotly-0.2.1/src/tests/test_bars.py

@@ -0,0 +1,310 @@
+# From https://plotly.com/python/bar-charts/ and https://plotly.com/python/horizontal-bar-charts/
+import plotly
+import plotly.express as px
+import pandas as pd
+import plotly.graph_objects as go
+from plotly.subplots import make_subplots
+
+import numpy as np
+import tikzplotly
+import os
+from warnings import warn
+from tikzplotly._tex import tex_create_document, tex_begin_environment, tex_end_environment, tex_end_all_environment
+
+def fig_vertical1():
+
+    data_canada = px.data.gapminder().query("country == 'Canada'")
+    fig = px.bar(data_canada, x='year', y='pop')
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig1.png"))
+
+    return fig, "Bar chart with Plotly Express"
+
+def fig_vertical2():
+
+    long_df = px.data.medals_long()
+
+    fig = px.bar(long_df, x="nation", y="count", color="medal", title="Long-Form Input")
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig2.png"))
+
+    return fig, "Bar charts with Long Format Data"
+
+def fig_vertical3():
+
+    wide_df = px.data.medals_wide()
+    fig = px.bar(
+        wide_df,
+        x="nation",
+        y=["gold", "silver", "bronze"],
+        title="Wide-Form Input",
+        color_discrete_map={
+            "gold": "gold",
+            "silver": "silver",
+            "bronze": "#cd7f32"
+        }
+    )
+    fig.update_traces(marker_line_width=2, marker_line_color="black")
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig3.png"))
+
+    return fig, "Bar charts with Wide Format Data"
+
+def fig_vertical5():
+
+    df = px.data.gapminder().query("country == 'Canada'")
+    fig = px.bar(df, x='year', y='pop',
+                hover_data=['lifeExp', 'gdpPercap'], color='lifeExp',
+                labels={'pop':'population of Canada'}, height=400)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig5.png"))
+
+    return fig, "Colored Bars"
+
+def fig_vertical6():
+
+    df = px.data.gapminder().query("continent == 'Oceania'")
+    fig = px.bar(df, x='year', y='pop',
+                hover_data=['lifeExp', 'gdpPercap'], color='country',
+                labels={'pop':'population of Canada'}, height=400)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig5bis.png"))
+
+    return fig, "Colored Bars"
+
+def fig_vertical7():
+
+    df = px.data.tips()
+    fig = px.bar(df, x="sex", y="total_bill", color='time')
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig6.png"))
+
+    return fig, "Stacked vs Grouped Bars"
+
+def fig_vertical8():
+
+    df = px.data.tips()
+    fig = px.bar(df, x="sex", y="total_bill",
+                color='smoker', barmode='group',
+                height=400)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig6bis.png"))
+
+    return fig, "Stacked vs Grouped Bars"
+
+def fig_vertical9():
+
+    df = px.data.tips()
+    fig = px.histogram(df, x="sex", y="total_bill",
+                color='smoker', barmode='group',
+                height=400)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig7.png"))
+
+    return fig, "Aggregating into Single Colored Bars"
+
+def fig_vertical10():
+
+    df = px.data.tips()
+    fig = px.histogram(df, x="sex", y="total_bill",
+                color='smoker', barmode='group',
+                histfunc='avg',
+                height=400)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig7bis.png"))
+
+    return fig, "Aggregating into Single Colored Bars"
+
+def fig_vertical11():
+
+    df = px.data.medals_long()
+
+    fig = px.bar(df, x="medal", y="count", color="nation", text_auto=True)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig8.png"))
+
+    return fig, "Bar Charts with Text"
+
+def fig_vertical12():
+
+    df = px.data.medals_long()
+
+    fig = px.bar(df, x="medal", y="count", color="nation", text="nation")
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig8bis.png"))
+
+    return fig, "Bar Charts with Text"
+
+def fig_vertical13():
+
+    df = px.data.gapminder().query("continent == 'Europe' and year == 2007 and pop > 2.e6")
+    fig = px.bar(df, y='pop', x='country', text_auto='.2s',
+                title="Default: various text sizes, positions and angles")
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig8ter.png"))
+
+    return fig, "Bar Charts with Text"
+
+def fig_vertical14():
+
+    df = px.data.gapminder().query("continent == 'Europe' and year == 2007 and pop > 2.e6")
+    fig = px.bar(df, y='pop', x='country', text_auto='.2s',
+                title="Controlled text sizes, positions and angles")
+    fig.update_traces(textfont_size=12, textangle=0, textposition="outside", cliponaxis=False)
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig8quater.png"))
+
+    return fig, "Bar Charts with Text"
+
+def fig_vertical15():
+
+    df = px.data.medals_long()
+
+    fig = px.bar(df, x="medal", y="count", color="nation",
+                pattern_shape="nation", pattern_shape_sequence=[".", "x", "+"])
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig9.png"))
+
+    return fig, "Pattern fills"
+
+def fig_vertical16():
+    animals=['giraffes', 'orangutans', 'monkeys']
+
+    fig = go.Figure([go.Bar(x=animals, y=[20, 14, 23])])
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig10.png"))
+
+    return fig, "Basic Bar Charts with plotly graph objects"
+
+def fig_vertical17():
+    animals=['giraffes', 'orangutans', 'monkeys']
+
+    fig = go.Figure(data=[
+        go.Bar(name='SF Zoo', x=animals, y=[20, 14, 23]),
+        go.Bar(name='LA Zoo', x=animals, y=[12, 18, 29])
+    ])
+    # Change the bar mode
+    fig.update_layout(barmode='group')
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig11.png"))
+
+    return fig, "Grouped Bar Chart"
+
+def fig_vertical18():
+    animals=['giraffes', 'orangutans', 'monkeys']
+
+    fig = go.Figure(data=[
+        go.Bar(name='SF Zoo', x=animals, y=[20, 14, 23]),
+        go.Bar(name='LA Zoo', x=animals, y=[12, 18, 29])
+    ])
+    # Change the bar mode
+    fig.update_layout(barmode='stack')
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig12.png"))
+
+    return fig, "Stacked Bar Chart"
+
+def fig_vertical19():
+    x = [1, 2, 3, 4]
+
+    fig = go.Figure()
+    fig.add_trace(go.Bar(x=x, y=[1, 4, 9, 16]))
+    fig.add_trace(go.Bar(x=x, y=[6, -8, -4.5, 8]))
+    fig.add_trace(go.Bar(x=x, y=[-15, -3, 4.5, -8]))
+    fig.add_trace(go.Bar(x=x, y=[-1, 3, -3, -4]))
+
+    fig.update_layout(barmode='relative', title_text='Relative Barmode')
+
+    # fig.show()
+    # fig.write_image(os.path.join(file_directory, "outputs", "test_bars", "fig13.png"))
+
+    return fig, "Bar Chart with Relative Barmode"
+
+def fig_horizontal1():
+    df = px.data.tips()
+    fig = px.bar(df, x="total_bill", y="day", orientation='h')
+    return fig, "Horizontal figure"
+
+def fig_horizontal2():
+    fig = go.Figure(go.Bar(
+            x=[20, 14, 23],
+            y=['giraffes', 'orangutans', 'monkeys'],
+            orientation='h'))
+    return fig, "Basic Horizontal Bar Chart"
+
+
+if __name__ == "__main__":
+
+    print("Tikzploty : ", tikzplotly.__version__)
+    print("Plotly : ", plotly.__version__)
+    print("Test histograms")
+
+
+    file_directory = os.path.dirname(os.path.abspath(__file__))
+
+    functions = [
+        ("vertical1", fig_vertical1),
+        ("vertical2", fig_vertical2),
+        ("vertical3", fig_vertical3),
+        ("vertical5", fig_vertical5),
+        ("vertical6", fig_vertical6),
+        ("vertical7", fig_vertical7),       # Stacked bars are not supported yet.
+        ("vertical8", fig_vertical8),       # Stacked bars are not supported yet.
+        ("vertical9", fig_vertical9),       # Aggregated bars are not supported yet.
+        ("vertical10", fig_vertical10),     # Aggregated bars are not supported yet.
+        ("vertical11", fig_vertical11),     # Text template is not supported yet.
+        ("vertical12", fig_vertical12),     # Text template is not supported yet.
+        ("vertical13", fig_vertical13),     # Text template is not supported yet.
+        ("vertical14", fig_vertical14),     # Text template is not supported yet.
+        ("vertical15", fig_vertical15),     # Pattern fills are not supported yet.
+        ("vertical16", fig_vertical16),
+        ("vertical17", fig_vertical17),
+        ("vertical18", fig_vertical18),
+        ("vertical19", fig_vertical19),
+        ("horizontal1", fig_horizontal1),
+        ("horizontal2", fig_horizontal2),
+    ]
+
+    main_tex_content = tex_create_document(options="twocolumn", compatibility="newest")
+    main_tex_content += "\\usepackage[left=1cm, right=1cm, top=1cm, bottom=1cm]{geometry}\n"
+    main_tex_content += "\n"
+    stack_env = []
+    main_tex_content += tex_begin_environment("document", stack_env) + '\n'
+
+    output_path = os.path.join(file_directory, "outputs", "test_bars")
+    if not os.path.exists(output_path):
+        os.makedirs(output_path)
+
+    for i, f in functions:
+        print(f"Figure {i}")
+        fig, title = f()
+        data = fig.data
+        save_path = os.path.join(file_directory, "outputs", "test_bars", "fig{}.tex".format(i))
+        tikzplotly.save(save_path, fig)
+        main_tex_content += tex_begin_environment("figure", stack_env)
+        main_tex_content += "  \\input{fig" + str(i) + ".tex}\n"
+        main_tex_content += "  \\caption{" + title + "}\n"
+        main_tex_content += tex_end_environment(stack_env) + '\n'
+
+    main_tex_content += "\n" + tex_end_all_environment(stack_env)
+
+    main_tex_path = os.path.join(file_directory, "outputs", "test_bars", "main.tex")
+    print("Save main tex file : ", main_tex_path)
+    with open(main_tex_path, "w") as f:
+        f.write(main_tex_content)

{tikzplotly-0.2.0 → tikzplotly-0.2.1}/src/tests/test_line_charts.py

@@ -394,6 +394,29 @@ def fig18():
     fig.update_xaxes(minor=dict(ticks="inside", ticklen=6, showgrid=True))
     return fig, "Log scale with range and minor ticks"
 
+def fig19():
+    df = pd.DataFrame(dict(
+        x = ["A et B", "B", "C", "D"],
+        y = [1, 2, 3, 4],
+    ))
+    fig = px.line(df, x="x", y="y", title="symbolic x coords")
+    return fig, "Line Charts with symbolic x coords"
+
+def fig20():
+    df = pd.DataFrame(dict(
+        x = [1, 2, 3, 4],
+        y = ["A", "B", "C", "D"],
+    ))
+    fig = px.line(df, x="x", y="y", title="symbolic y coords")
+    return fig, "Line Charts with symbolic y coords"
+
+
+def fig21(x=True, y=False):
+    fig = px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])
+    if x: fig.data[0].x = None
+    if y: fig.data[0].y = None
+    return fig, "empty fig"
+
 if __name__ == "__main__":
 
     print("Tikzploty : ", tikzplotly.__version__)
@@ -414,12 +437,15 @@ if __name__ == "__main__":
         ("9", fig9),
         ("10", fig10),
         ("11", fig11),
-        # ("12", fig12),
+        ("12", fig12),
         ("14", fig14),
         ("15", fig15),
         ("16", fig16),
         ("17", fig17),
         ("18", fig18),
+        ("19", fig19),
+        ("20", fig20),
+        ("21", fig21),
     ]
 
     main_tex_content = tex_create_document(options="twocolumn", compatibility="newest")

{tikzplotly-0.2.0 → tikzplotly-0.2.1}/src/tests/test_markers.py

@@ -6,7 +6,7 @@ import numpy as np
 import tikzplotly
 import os
 import plotly.graph_objects as go
-from plotly.validators.scatter.marker import SymbolValidator
+from plotly.validator_cache import ValidatorCache
 from warnings import warn
 from tikzplotly._tex import tex_create_document, tex_begin_environment, tex_end_environment, tex_end_all_environment
 
@@ -226,7 +226,8 @@ def fig3ter():
 
 def fig4():
     warn("This example is not exactly the one online, but has been changed as this kind of data is not yet supported.")
-    raw_symbols = SymbolValidator().values
+    SymbolValidator = ValidatorCache.get_validator("scatter.marker", "symbol")
+    raw_symbols = SymbolValidator.values
     namestems = []
     namevariants = []
     symbols = []