pimpmyplot 0.0.1__tar.gz

pimpmyplot-0.0.1/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,53 @@
+
+
+
+# Pimp My Plot
+
+<p align="center">
+  <img src="assets/pimpmyplotlogo.png" width="30%"/>
+</p>
+
+
+
+This is a small collection of functions to make better looking matplotlib plots.
+
+The package has minimal dependencies and fully compatible with standard `matplotlib` library.
+
+
+
+## Getting started
+
+Install the package via pip
+
+```
+pip instsall pimpmyplot
+```
+
+
+Use the package simply calling its functions after you created a matplotlib plot
+
+
+```
+import pimpmyplot as pmp
+import matplotlib.pyplot as plt
+import numpy as np
+
+x = np.linspace(0, 10, 100)
+plt.figure(figsize=(4, 4))
+plt.plot(x, np.sin(x), label='A')
+
+pmp.legend()                        # same as plt legend but better looking and horizontal labels as default
+pmp.bullet_grid(stepinch=.3)        # dotted grid similar to a bllet journal
+pmp.remove_axis('top', 'right')     # remove axis in a simpler way
+pmp.remove_ticks()                  # remove ticks in a simpler way
+```
+
+<br>
+<p align="center">
+  <img src="assets/stdplot.png" width="40%"/>
+</p>
+
+
+## Demo
+
+For a small interactive demo visit [this marimo notebook](https://molab.marimo.io/notebooks/nb_R7uUAUWZfgRioAqmzL9XJm) on molab.

pimpmyplot-0.0.1/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-0.0.1/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-0.0.1/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-0.0.1/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-0.0.1/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/pimpmyplot.egg-info/PKG-INFO

@@ -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/pimpmyplot.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+setup.py
+pimpmyplot/__init__.py
+pimpmyplot/axis.py
+pimpmyplot/grid.py
+pimpmyplot/legend.py
+pimpmyplot/utils.py
+pimpmyplot.egg-info/PKG-INFO
+pimpmyplot.egg-info/SOURCES.txt
+pimpmyplot.egg-info/dependency_links.txt
+pimpmyplot.egg-info/requires.txt
+pimpmyplot.egg-info/top_level.txt
+test/test_functions.py

pimpmyplot-0.0.1/pimpmyplot.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pimpmyplot-0.0.1/pimpmyplot.egg-info/requires.txt

@@ -0,0 +1,2 @@
+matplotlib
+numpy

pimpmyplot-0.0.1/pimpmyplot.egg-info/top_level.txt

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

pimpmyplot-0.0.1/setup.cfg

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

pimpmyplot-0.0.1/setup.py

@@ -0,0 +1,30 @@
+from setuptools import setup, find_packages
+
+__version__ = '0.0.1'
+
+with open('README.md', 'r', encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name='pimpmyplot',
+    version=__version__,
+    author='andrea maioli',
+    author_email='maioliandrea0@gmail.com',
+    description='Small collection of functions to make better looking matplotlib plots',
+    #long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/clarkmaio/pimpmyplot',
+    packages=find_packages(), 
+    classifiers=[
+        'Programming Language :: Python :: 3',
+        'License :: OSI Approved :: MIT License', 
+        'Operating System :: OS Independent',
+        'Topic :: Scientific/Engineering :: Artificial Intelligence',
+        'Topic :: Scientific/Engineering :: Mathematics',
+    ],
+    python_requires='>=3.7',
+    install_requires=[
+            "matplotlib",
+            "numpy"
+    ],
+)

pimpmyplot-0.0.1/test/test_functions.py

@@ -0,0 +1,57 @@
+
+
+
+
+import matplotlib.pyplot as plt
+import numpy as np
+import pimpmyplot as pmp
+
+
+def demoplot():
+    x = np.linspace(0, 10, 100)
+    plt.plot(x, np.sin(x), label='A')
+
+def demosubplot():
+    x = np.linspace(0, 10, 100)
+    fig, ax = plt.subplots(1, 2)
+
+    ax[0].plot(x, np.sin(x), label='A')
+    ax[1].plot(x, np.cos(x), label='B')
+    return fig, ax
+
+
+
+
+def test_remove_axis():
+    demoplot()
+    pmp.remove_axis()
+
+    fig, ax = demosubplot()
+    pmp.remove_axis(ax=ax[1])
+
+
+def test_remove_ticks():
+    demoplot()
+    pmp.remove_ticks()
+
+    fig, ax = demosubplot()
+    pmp.remove_ticks(ax=ax[1])
+
+
+def test_legend():
+    demoplot()
+    pmp.legend()
+
+    fig, ax = demosubplot()
+    pmp.legend(ax=ax[1])
+
+
+def test_bullet_grid():
+    demoplot()
+    pmp.bullet_grid()
+
+    fig, ax = demosubplot()
+    pmp.bullet_grid(ax=ax[1])
+
+
+