tikzplot42 0.2.8__tar.gz → 0.3.0__tar.gz

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.2.8
+Version: 0.3.0
 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
@@ -703,7 +703,7 @@ Dynamic: license-file
 # TikzPlot
 A clean version of PltToTikz, this time as Python package. Easy to use: only replace import matplotlib.pyplot with this library.
 
-Please let me know if you find any bugs or unexpected behaviour. When the project will be ready, I might publish it on PyPI.
+Please let me know if you find any bugs or unexpected behaviour. Examples may be found in repository under `tests/` directory.
 
 # Installation
 NEW: PyPI: `pip install tikzplot42`.
@@ -713,13 +713,14 @@ 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
-- `\usepackage{tikz}`
-- `\usepackage{pgfplots}`
-- `\pgfplotsset{compat=1.18}`
+- `\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).
 
+Export using `plt.savefig("example_graph.tex")` (recommended) or `plt.show()`.
 Then use the generated file as `\input{example_graph.tex}`.
 
 ## Currently implemented:

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/README.md

@@ -1,7 +1,7 @@
 # TikzPlot
 A clean version of PltToTikz, this time as Python package. Easy to use: only replace import matplotlib.pyplot with this library.
 
-Please let me know if you find any bugs or unexpected behaviour. When the project will be ready, I might publish it on PyPI.
+Please let me know if you find any bugs or unexpected behaviour. Examples may be found in repository under `tests/` directory.
 
 # Installation
 NEW: PyPI: `pip install tikzplot42`.
@@ -11,13 +11,14 @@ 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
-- `\usepackage{tikz}`
-- `\usepackage{pgfplots}`
-- `\pgfplotsset{compat=1.18}`
+- `\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).
 
+Export using `plt.savefig("example_graph.tex")` (recommended) or `plt.show()`.
 Then use the generated file as `\input{example_graph.tex}`.
 
 ## Currently implemented:

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/pyproject.toml

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

tikzplot42-0.3.0/src/tikzplot/__init__.py

@@ -0,0 +1,5 @@
+from . import plots, figure, axes, axes3d
+from .config import TikzConfig
+from .colorbar import Colorbar
+
+__all__ = ["plots", "figure", "axes", "axes3d", "TikzConfig", "Colorbar"]

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/src/tikzplot/axes.pyi

@@ -156,6 +156,8 @@ class BaseAxes:
              label:Optional[str]=...) -> None: 
         """
         Draw a stem plot to the selected axis.
+        Parameters
+        ----------
         locs, heads: ArrayLike
             Datapoints for plot, (x,y) for vertical, (y,x) for horizontal
 
@@ -404,7 +406,7 @@ class Axes(BaseAxes):
         linewidth or lw: float, optional
             Grid line width in pt
         """
-    def set_minorticks_on(self, num: int) -> None:
+    def set_minorticks_num(self, num: int) -> None:
         ...
         """
         Set number of minor ticks between major ticks.

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/src/tikzplot/colorbar.pyi

@@ -32,10 +32,10 @@ class Colorbar:
         ticks: Optional[Sequence[ float]] = ...,
         tick_labels: Optional[Sequence[str | float]] = ...,
         label: Optional[str] = ...,
-        width: float = ...,
-        horizontal: bool = ...,
-        rel_len: float = ...,
-        divisions: int = ...
+        width: Optional[float] = ...,
+        horizontal: Optional[bool] = ...,
+        rel_len: Optional[float] = ...,
+        divisions: Optional[int] = ...
     ) -> None:
         """
         Parameters

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/src/tikzplot/config.pyi

@@ -20,6 +20,8 @@ class _ConfigParams(TypedDict, total=False):
     SEC_Y_LABEL_PADDING: float
     TITLE_PADDING: float
     X_LABEL_PADDING: float
+    XTICK_PADDING: float
+    YTICK_PADDING: float
 
     DEFAULT_WIDTH: float
     DEFAULT_HEIGHT: float

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/src/tikzplot/plots.pyi

@@ -55,6 +55,10 @@ def subplots(
         - Single Axes if nrows*ncols == 1
         - 1D array if one dimension is 1
         - 2D array otherwise
+    figsize : tuple, optional
+        Figure size in inches (width, height).
+    sharex, sharey : Axes, optional
+        Specify if row, column or all subplots should share x or y axis.
     """
     ...
 
@@ -204,7 +208,36 @@ def plot(
         Mark size in pt
     """
     ...
-
+def errorbar(self, x: ArrayLike = ..., y: ArrayLike = ..., yerr: Optional[ArrayLike | float] = ..., xerr: Optional[ArrayLike | float] = ..., fmt: Optional[str] = ..., *, alpha: Optional[float] = ..., color: Optional[ColorLike] = ..., c: Optional[ColorLike] = ...,
+             linestyle: Optional[LineStyle] = ..., ls: Optional[LineStyle] = ..., linewidth: Optional[float]= ..., lw: Optional[float] = ...,
+             marker: Optional[MarkerStyle] = ..., markersize: Optional[float] = ..., ms: Optional[float] = ...,  label:Optional[str]=...) -> None:
+    """
+    Draw a plot with errrorbars to the selected axis.
+    Parameters
+    ----------
+    x,y : ArrayLike or float
+        Datapoints
+    yerr, xerr: ArrayLike or float
+        Datapoint error (constant, symmetric, asymmetric)
+    fmt: str, optional
+        Style
+    alpha: float, optional
+        Opacity
+    color or c: all matplotlib color formats (without X11/xkcd), optional
+        color of line and markers: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+    label: str, optional
+        Legned entry
+    linestyle or ls: str, optional
+        Line style
+    linewidth or lw: float, optional
+        Line width in pt
+    
+    marker: str, optional
+        Marker type
+    markersize or ms: float, optional
+        Mark size in pt
+    """
+    ...
 def scatter(
     x: ArrayLike = ..., y: ArrayLike = ..., fmt: Optional[str] = ...,
     *,
@@ -291,7 +324,153 @@ def semilogy(
     """
     ...
 
-# --- Output ---
+def stem(self, *args: Any, orientation: Literal["horizontal","vertical"] = "vertical", linefmt:Optional[str] = ..., markerfmt:Optional[str]=...,
+         label:Optional[str]=...) -> None: 
+    """
+    Draw a stem plot to the selected axis.
+    Parameters
+    ----------
+    locs, heads: ArrayLike
+        Datapoints for plot, (x,y) for vertical, (y,x) for horizontal
+    orientation: {"vertical", "horizontal"}, default "vertical
+        Orientation of stems
+    alpha: float, optional
+        Opacity
+    linefmt, markerfmt: str, optional
+        Short style of line and marker
+    label: str, optional
+        Legend entry
+    """
+    ...
+
+def fill_between(
+    self,
+    x: ArrayLike,
+    y1: ArrayLike,
+    y2: Optional[ArrayLike] = ...,
+    alpha: Optional[float] = ...,
+    color: Optional[ColorLike] = ...,
+    c: Optional[ColorLike] = ...
+) -> None: 
+    """
+    Fill space between two plots (or a single plot and x-axis).
+    Parameters
+    ----------
+    x,y1, y2 : ArrayLike or float (y2 optional)
+        Datapoints, if matched with existing plot, that line will be recycled to save tikz memory.
+    alpha: float, optional
+        Opacity
+    color or c: all matplotlib color formats (without X11/xkcd), optional
+        Fill color: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+    label: str, optional
+        Legend entry
+    """
+    ...
+
+def loglog(self, x: ArrayLike = ..., y: ArrayLike = ..., base: Optional[float] = 10,  fmt: Optional[str] = ...,*, alpha: Optional[float] = ..., color: Optional[ColorLike] = ..., c: Optional[ColorLike] = ...,
+             linestyle: Optional[LineStyle] = ..., ls: Optional[LineStyle] = ..., linewidth: Optional[float]= ..., lw: Optional[float] = ...,
+             marker: Optional[MarkerStyle] = ..., markersize: Optional[float] = ..., ms: Optional[float] = ...) -> None:
+    """
+    Draw a general plot to the selected axis and change the current axis into log mode.
+
+    Parameters
+    ----------
+    x,y : ArrayLike or float
+        Datapoints
+    base: float, optional
+        Log basis, default 10
+    fmt: str, optional
+        Style
+    alpha: float, optional
+        Opacity
+    color or c: all matplotlib color formats (without X11/xkcd), optional
+        color of line and markers: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+    label: str, optional
+        Legned entry
+    linestyle or ls: str, optional
+        Line style
+    linewidth or lw: float, optional
+        Line width in pt
+    
+    marker: str, optional
+        Marker type
+    markersize or ms: float, optional
+        Mark size in pt
+    """
+    ...
+
+def hlines(
+    self,
+    y: Union[float, Sequence[float]],
+    xmin: Union[float, Sequence[float]],
+    xmax: Union[float, Sequence[float]],
+    colors: Union[str, Sequence[str]] = "k",
+    linestyles: Union[str, Sequence[str]] = "solid",
+) -> None: 
+    """
+    Draw horizontal lines to the selected axis.
+    """
+    ...
+
+def vlines(
+    self,
+    x: Union[float, Sequence[float]],
+    ymin: Union[float, Sequence[float]],
+    ymax: Union[float, Sequence[float]],
+    colors: Union[str, Sequence[str]] = "k",
+    linestyles: Union[str, Sequence[str]] = "solid",
+) -> None: 
+    """
+    Draw vertical lines to the selected axis.
+    """
+    ...
+
+def semilogx(self, x: ArrayLike = ..., y: ArrayLike = ..., base: Optional[float] = 10,  fmt: Optional[str] = ...,*, alpha: Optional[float] = ..., color: Optional[ColorLike] = ..., c: Optional[ColorLike] = ...,
+             linestyle: Optional[LineStyle] = ..., ls: Optional[LineStyle] = ..., linewidth: Optional[float]= ..., lw: Optional[float] = ...,
+             marker: Optional[MarkerStyle] = ..., markersize: Optional[float] = ..., ms: Optional[float] = ...) -> None:
+    """
+    Draw a general plot to the selected axis and change the current x-axis into log mode.
+    Parameters
+    ----------
+    x,y : ArrayLike or float
+        Datapoints
+    base: float, optional
+        Log basis, default 10
+    fmt: str, optional
+        Style
+    alpha: float, optional
+        Opacity
+    color or c: all matplotlib color formats (without X11/xkcd), optional
+        color of line and markers: RGB/RGBA (tuple), HEX (str), grayscale (float), single-char (str), name (str), default cycle ("CX", X int), none for invisible
+    label: str, optional
+        Legned entry
+    linestyle or ls: str, optional
+        Line style
+    linewidth or lw: float, optional
+        Line width in pt
+    
+    marker: str, optional
+        Marker type
+    markersize or ms: float, optional
+        Mark size in pt
+    """
+    ...
+def imshow(self, *args: Any, cmap: Optional[str] = ...) -> Tuple[Any, str, float, float]: 
+    """
+    Draw image to the selected axis from array. Uses matplotlib imshow() to export to PDF, then inputs the image to the axis. Return may be used to initialize Colorbar().
+    """
+    ...
+
+def minorticks_num(self, num: int) -> None:
+    ...
+    """
+    Set number of minor ticks between major ticks.
+    
+    Parameters
+    ----------
+    num: int
+        Number of minor ticks between major ticks.
+    """
 
 def savefig(filename: str) -> None:
     """
@@ -311,4 +490,10 @@ def clf() -> None:
     """
     Clear current figure.
     """
+    ...
+
+def gca() -> Axes:
+    """
+    Get current axis.
+    """
     ...

{tikzplot42-0.2.8 → tikzplot42-0.3.0}/src/tikzplot42.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tikzplot42
-Version: 0.2.8
+Version: 0.3.0
 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
@@ -703,7 +703,7 @@ Dynamic: license-file
 # TikzPlot
 A clean version of PltToTikz, this time as Python package. Easy to use: only replace import matplotlib.pyplot with this library.
 
-Please let me know if you find any bugs or unexpected behaviour. When the project will be ready, I might publish it on PyPI.
+Please let me know if you find any bugs or unexpected behaviour. Examples may be found in repository under `tests/` directory.
 
 # Installation
 NEW: PyPI: `pip install tikzplot42`.
@@ -713,13 +713,14 @@ 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
-- `\usepackage{tikz}`
-- `\usepackage{pgfplots}`
-- `\pgfplotsset{compat=1.18}`
+- `\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).
 
+Export using `plt.savefig("example_graph.tex")` (recommended) or `plt.show()`.
 Then use the generated file as `\input{example_graph.tex}`.
 
 ## Currently implemented:

tikzplot42-0.2.8/src/tikzplot/__init__.py

@@ -1,5 +0,0 @@
-from . import plots
-from .config import TikzConfig
-from .colorbar import Colorbar
-
-__all__ = ["plots", "TikzConfig", "Colorbar"]