tikzplot42 0.5.0__tar.gz → 0.5.2__tar.gz

{tikzplot42-0.5.0/src/tikzplot42.egg-info → tikzplot42-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.5.0
+Version: 0.5.2
 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
@@ -706,6 +706,18 @@ Please report any bugs or unexpected behaviour in Issues. Examples may be found
   <img src="https://raw.githubusercontent.com/ZanAmb/TikzPlot/main/tests/demo.png" width="60%">
 </p>
 
+## Why use pgfplots instead of matplotlib?
+- Tikz/pgfplots is a LaTeX package, so it is easy to integrate into your LaTeX document, and the fonts will match your document, rescaling will not affect font sizes.
+- Tikz/pgfplots graph is easy to edit, especially if only minor style changes are needed, while matplotlib requires re-running the code to generate a new graph.
+- Full math mode is supported, so you can use LaTeX math in your labels, legends, etc.
+
+## Why use this package instead of other available?
+- It is easy to use, with code being very similar to matplotlib and only minor changes are needed to switch from matplotlib to this package.
+- It relies on frontend commands, which is less likley to change in matplotlib, so new updates do not break it.
+- It generates clean and readable Tikz code, which is easy to edit and understand. Code is also efficient and does not contain unnecessary commands, which is important escpecially for large graphs.
+- If you use LLMs to generate pgfplots code, you will often get code that is not compilable, since for more complex requirements, LLMs make up commands that do not exist. This package covers many use cases and generates compilable code.
+
+
 # Installation
 PyPI: `pip install tikzplot42`.
 Alternativley, download this package and install using: `pip install [path]`, where [path] is the path to the directory, containing `pyproject.toml`.
@@ -740,6 +752,8 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `hlines()/vlines()`,
 - `hist()`,
 - `bar()/barh()`,
+- `bar_label()`,
+- `stackplot()`,
 - `step()`,
 - `imshow()`,
 - `text()`,
@@ -763,7 +777,8 @@ If axes and plot have different name for command with same effect, both are impl
 - `ax.set_xticklabels()/ax.set_yticklabels()`,
 - `legend()` (basic position control),
 - `ax.twinx()`,
-- `ax.set()`.
+- `ax.set()`,
+- `ax.tick_params()`,
 
 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).
 
@@ -790,6 +805,6 @@ 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...
-- additional arguments supprot for implemented commands,
+- additional arguments support for implemented commands,
 - improved 3D plots (currently only basic support: plot, errorbar, fill_between, scatter, plot_wireframe, plot_surface),
 - ... 

{tikzplot42-0.5.0 → tikzplot42-0.5.2}/README.md

@@ -7,6 +7,18 @@ Please report any bugs or unexpected behaviour in Issues. Examples may be found
   <img src="https://raw.githubusercontent.com/ZanAmb/TikzPlot/main/tests/demo.png" width="60%">
 </p>
 
+## Why use pgfplots instead of matplotlib?
+- Tikz/pgfplots is a LaTeX package, so it is easy to integrate into your LaTeX document, and the fonts will match your document, rescaling will not affect font sizes.
+- Tikz/pgfplots graph is easy to edit, especially if only minor style changes are needed, while matplotlib requires re-running the code to generate a new graph.
+- Full math mode is supported, so you can use LaTeX math in your labels, legends, etc.
+
+## Why use this package instead of other available?
+- It is easy to use, with code being very similar to matplotlib and only minor changes are needed to switch from matplotlib to this package.
+- It relies on frontend commands, which is less likley to change in matplotlib, so new updates do not break it.
+- It generates clean and readable Tikz code, which is easy to edit and understand. Code is also efficient and does not contain unnecessary commands, which is important escpecially for large graphs.
+- If you use LLMs to generate pgfplots code, you will often get code that is not compilable, since for more complex requirements, LLMs make up commands that do not exist. This package covers many use cases and generates compilable code.
+
+
 # Installation
 PyPI: `pip install tikzplot42`.
 Alternativley, download this package and install using: `pip install [path]`, where [path] is the path to the directory, containing `pyproject.toml`.
@@ -41,6 +53,8 @@ Some basic plot commands are already implemented with commonly used arguments:
 - `hlines()/vlines()`,
 - `hist()`,
 - `bar()/barh()`,
+- `bar_label()`,
+- `stackplot()`,
 - `step()`,
 - `imshow()`,
 - `text()`,
@@ -64,7 +78,8 @@ If axes and plot have different name for command with same effect, both are impl
 - `ax.set_xticklabels()/ax.set_yticklabels()`,
 - `legend()` (basic position control),
 - `ax.twinx()`,
-- `ax.set()`.
+- `ax.set()`,
+- `ax.tick_params()`,
 
 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).
 
@@ -91,6 +106,6 @@ 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...
-- additional arguments supprot for implemented commands,
+- additional arguments support for implemented commands,
 - improved 3D plots (currently only basic support: plot, errorbar, fill_between, scatter, plot_wireframe, plot_surface),
 - ... 

{tikzplot42-0.5.0 → tikzplot42-0.5.2}/pyproject.toml

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