Metadata-Version: 2.4
Name: lipstick
Version: 0.0.10
Summary: A collection of plotting functions.
Author-email: Mohammad Bashiri <mohammadbashiri93@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/mohammadbashiri/lipstick
Keywords: plotting,visualization
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib>=3.3.0
Requires-Dist: pillow>=7.2.0
Requires-Dist: imageio>=2.9.0
Dynamic: license-file

# Lipstick 💄

Lipstick is a simple, lightweight set of tools for creating beautiful visualizations.
Just apply some lipstick to your data and you're ready to go!

## Installation

Install the latest version of Lipstick with `pip`:

```bash
pip install lipstick
```

or install the latest development version from GitHub:

```bash
pip install git+git://github.com/mohammadbashiri/lipstick.git
```

## Example usage

### Creating a gif

Creating animated gifs is easy with Lipstick.

```python

``` python
import numpy as np
import matplotlib.pyplot as plt
from lipstick import GifMaker

with GifMaker("sample.gif") as g:
    
    for i in range(30): # go through the frames

        # create a figure
        fig, ax = plt.subplots(figsize=(2, 2), dpi=150)
        ax.imshow(np.random.rand(3, 3))
        ax.text(2, 2, i, ha='center', va='center')
        ax.set(xticks=[], yticks=[])
        
        # add the figure object to the GifMaker
        g.add(fig)
        
g.show()
```

<p align="center">
  <img width="300" height="300" src="images/sample.gif">
</p>

### Updating the displayed figure in a loop

You have a loop and you want to update the same figure (with new results) as you go through the loop? You can also use the `update_fig` method:

<p align="center">
  <img width="450" height="600" src="images/update_fig_demo.gif">
</p>

## :bug: Report bugs (or request features)

If you find a bug or would like to see new features, please create an issue or make a PR :star2:
