Skip to main content

A Python 3.6 library for tweaking matplotlib figures.

Project description

.. raw:: html

<h1 align="center">

mpl-helpers

.. raw:: html

</h2>

.. raw:: html

<p align="center">

A Python 3.6 library for tweaking matplotlib figures

.. raw:: html

</p>

.. raw:: html

<p align="center">

Installation · Tutorial · Contributing

.. raw:: html

</p>

.. raw:: html

<p align="center">

.. raw:: html

</p>

.. raw:: html

<h3 align="center">

Installation

.. raw:: html

</h3>

::

❯ pip install mpl_helpers

Please not this project is under active and early development.

Documentation, tests, and a consistent API will be provided in due time!

.. raw:: html

<h3 align="center">

Tutorial

.. raw:: html

</h3>

.. code:: python

from mpl_helpers import *

**axis_off**: turn off x, y, or all axis in an ``ax``

**darken_rgb**: darken an RGB value by a given percent

**despine**: remove either of the four spines in a cartesian ``ax``

**grouped_bar_positions**: create equi-spaced positions centered around
integers

**is_luminous**: determines if an RGB value is luminous

**lighten_rgb**: lighten an RGB value by a given percent

**maximum_xlim_bounds**: return the maximum xlim bounds by all ``ax``
objects

**maximum_ylim_bounds**: return the minimum xlim bounds by all ``ax``
objects

**ticklabels_to_integer**: use an integer formatter on ticklabels

**ticklabels_to_percent**: use a percent formatter on ticklabels

**ticklabels_to_scientific**: use a scientific notation formatter on
ticklabels

**ticklabels_to_thousands_sep**: use a thousands seperated comma
formatter on ticklabels

**remove_every_other_tick**: remove every other tick

**ticks_off**: turn off x, y, or all axis ticks in an ``ax``

.. raw:: html

<h3 align="center">

Contributing

.. raw:: html

</h3>

Pull requests, feature requests, and issues welcome!

To make a development install:

.. code:: bash

❯ git clone git@github.com:clintval/mpl-helpers.git
❯ pip install -e 'mpl-helpers'

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page