pimpmyplot 0.0.1__py3-none-any.whl

pimpmyplot/__init__.py

@@ -0,0 +1,8 @@
+
+
+
+from ..setup import __version__
+
+from pimpmyplot.axis import *
+from pimpmyplot.legend import *
+from pimpmyplot.grid import bullet_grid

pimpmyplot/axis.py

@@ -0,0 +1,43 @@
+
+
+import matplotlib.pyplot as plt
+import matplotlib
+from typing import List
+
+from pimpmyplot.utils import setupax
+
+
+
+@setupax
+def remove_axis(*spines: str, ax: matplotlib.axes.Axes = None) -> None:
+    '''
+    Make axis not visible.
+
+    Params
+    -------
+    *sides : str
+        Options: 'top', 'bottom', 'left', 'right'. 
+        If nothing is passed all axis will be removed
+    
+    ax : plt.axis
+        Apply styling to this axis
+    '''
+
+    spines = ['top', 'bottom', 'left', 'right'] if len(spines) == 0 else spines
+    for s in spines:
+        ax.spines[s].set_visible(False)
+
+
+def remove_ticks(*spines: str, ax: plt.axis = None) -> None:
+
+    if not ax:
+        ax = plt.gca()
+
+    spines = ['top', 'bottom', 'left', 'right'] if len(spines) == 0 else spines
+    tickkwargs = {s: False for s in spines}
+    labelkwargs = {f'label{s}': False for s in spines}
+    ax.tick_params(
+        **tickkwargs,
+        **labelkwargs
+    )
+

pimpmyplot/grid.py

@@ -0,0 +1,47 @@
+
+
+import matplotlib
+from typing import Dict, Tuple
+import numpy as np
+from pimpmyplot.utils import setupax
+
+
+_DEFAULT_SCATTER_KWARGS = {
+    's': 2,
+    'color': '#cccccc',
+    'marker': 'o',
+    'alpha': .8,
+    'zorder': -100
+}
+
+
+
+def build_uniform_meshgrid(ax: matplotlib.axes.Axes, stepinch: float = .5) -> Tuple[np.array, np.array]:
+    """Create equispaced meshgrid relative to axis scale"""
+
+    # Deduce axis step to make mesh uniform
+    xmin, xmax = ax.get_xlim()
+    ymin, ymax = ax.get_ylim()
+    xrange, yrange = xmax - xmin, ymax - ymin
+    xinch, yinch = ax.figure.get_size_inches()
+    axwidth, axheight = ax.get_position().width, ax.get_position().height
+    xstep = xrange / (xinch * axwidth) * stepinch
+    ystep = yrange / (yinch * axheight) * stepinch
+
+    xpoints = np.arange(xmin, xmax + xstep/2, xstep)
+    ypoints = np.arange(ymin, ymax + ystep/2, ystep)
+    X, Y = np.meshgrid(xpoints, ypoints)
+    return X, Y
+
+
+
+@setupax
+def bullet_grid(ax: matplotlib.axes.Axes = None, stepinch: float = .5, scatter_kwargs: Dict = {}):
+    '''
+    Build grid similar to dotted bullet journals
+    '''
+    X, Y = build_uniform_meshgrid(ax=ax, stepinch=stepinch)
+
+    scatter_kwargs.update(_DEFAULT_SCATTER_KWARGS)
+    ax.scatter(X, Y, **scatter_kwargs)
+    

pimpmyplot/legend.py

@@ -0,0 +1,49 @@
+
+
+import matplotlib.pyplot as plt
+import matplotlib
+
+from pimpmyplot.utils import setupax
+
+from typing import Tuple
+
+
+@setupax
+def legend(*args, 
+           shadow: bool = True, 
+           frameon: bool = True,
+           loc: str = 'upper center',
+           bbox_to_anchor: Tuple = (.5, -.1),
+           edgecolor: str = 'k',
+           ax: matplotlib.axes.Axes = None,
+           ncol: int = None,
+           **kwargs) -> matplotlib.legend.Legend:
+    '''
+    Customize legend
+    '''
+
+    # Deduce number labels in legend
+    if ncol is None:
+        legend_handles = [line for line in ax.get_lines() if line.get_label() != '_nolegend_']
+        ncol = len(legend_handles)
+
+    # Call standard legend
+    l = ax.legend(*args, 
+                  shadow=shadow, 
+                  frameon=frameon, 
+                  loc=loc, 
+                  bbox_to_anchor=bbox_to_anchor, 
+                  edgecolor=edgecolor, 
+                  ncol=ncol,
+                  **kwargs)
+    
+    # Shadow style
+    l._shadow_props = {'ox': 3, 'oy': -3, 'color': 'black', 'shade': 1., 'alpha': 1.}
+
+    return l
+
+
+
+
+
+

pimpmyplot/utils.py

@@ -0,0 +1,19 @@
+
+
+import matplotlib.pyplot as plt
+from functools import wraps
+
+
+
+def setupax(func):
+    '''
+    If func takes in input ax argument replace it with plt.gca() in case it is None
+    '''
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        if 'ax' in kwargs:
+            kwargs['ax'] = plt.gca() if not kwargs['ax'] else kwargs['ax']
+        else:
+            kwargs['ax'] = plt.gca()
+        return func(*args, **kwargs)
+    return wrapper

pimpmyplot-0.0.1.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: pimpmyplot
+Version: 0.0.1
+Summary: Small collection of functions to make better looking matplotlib plots
+Home-page: https://github.com/clarkmaio/pimpmyplot
+Author: andrea maioli
+Author-email: maioliandrea0@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

pimpmyplot-0.0.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+pimpmyplot/__init__.py,sha256=zIqAg83Jfucd-EtdwnkFWTSlOKMjOSSlXeGl6_yVi38,138
+pimpmyplot/axis.py,sha256=MetK59lc0jlp2-VnhYslKWZnre8WCu1iLpv2e1r82d4,941
+pimpmyplot/grid.py,sha256=lYlTcFXoo7NU-1rdNF7AacBLfnHmDJtyKICAiKHE_fs,1268
+pimpmyplot/legend.py,sha256=doj61slAgF1xIvK0H-5GzC1pezI4-o3h3_VNQbZGV5c,1107
+pimpmyplot/utils.py,sha256=DD-d3D7IwV3VYflkmrbtU2MPfrcUTxHtM5xqq7gT1ps,444
+pimpmyplot-0.0.1.dist-info/METADATA,sha256=1vbAYTsqqvtXE1lh9efaUyUaJo7wjhQkwQ8TxjmE4HA,806
+pimpmyplot-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pimpmyplot-0.0.1.dist-info/top_level.txt,sha256=4w6jM0kymzs9nn38Jw2V-hAI1bQ0vRADWi0xRYPCgiE,11
+pimpmyplot-0.0.1.dist-info/RECORD,,

pimpmyplot-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pimpmyplot-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+pimpmyplot