Adding 2d macros

Author: Dylan

LICENSE.txt

@@ -0,0 +1,30 @@
+Copyright (c) 2021 Dylan Walsh
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+       copyright notice, this list of conditions and the following
+       disclaimer in the documentation and/or other materials provided
+       with the distribution.
+
+    * Neither the name of the plotly-gif Developers nor the names of any
+       contributors may be used to endorse or promote products derived
+       from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,82 @@
+# Plotly-gif 
+
+---
+---
+
+A simple python package to generate .gif from your plotly figures. It works for both 2D and 3D figures. It can even 
+create_gif motion for you in 3D plots. 
+
+## Installation
+
+```
+pip install plotly-gif
+```
+
+### Dependencies
+
+If you are already using plotly, then you should be good. But, just in case, these are the dependencies:
+```python
+pip install numpy
+pip install plotly    
+pip install kaleido   # used by plotly to generate png
+pip install Pillow    # used to convert png to gif
+```    
+
+---
+## Usage
+
+There are three common methods:
+
+### Built-in Functions
+
+
+
+### Decorator
+
+If you have a function that is changing the `go.Figure' with each loop, you can add the decorator to the func.
+
+```python
+import plotly.graph_objs as go
+from plotly_gif import GIF, capture
+
+gif = GIF()
+
+@capture(gif)
+def plot_(x_, y_):
+    fig = go.Figure()
+    # add your traces()
+    # add your formatting()
+    
+    return fig
+
+gif.create_gif() # generate gif
+```
+
+### In-Line
+This very similar to the decorator option, but you can call the image capture function directly.
+
+```python
+import plotly.graph_objs as go
+from plotly_gif import GIF, capture
+
+gif = GIF()
+
+def plot_(x_, y_):
+    fig = go.Figure()
+    # add your traces()
+    # add your formatting()
+    
+    gif.create_image(fig)  # create_gif image for gif
+    
+    return fig
+
+gif.create_gif() # generate gif
+```
+
+---
+## Options
+
+
+---1
+## Examples
+

examples/example_1.py

@@ -0,0 +1,30 @@
+import numpy as np
+import plotly.graph_objs as go
+from plotly_gif import GIF, capture
+
+
+# create_gif some data
+n = 100
+x = np.linspace(0, n-1, n)
+y = np.sin(x) + np.random.rand(n)
+
+# Create gif class to store data
+gif = GIF(verbose=True)
+
+
+@capture(gif)  # tells gif to save each figure that is generate from this function
+def plot_(x_, y_):
+    # function that generates plotly figures
+    fig = go.Figure()
+    fig.add_trace(go.Scatter(x=x_, y=y_, mode="lines"))
+
+    return fig
+
+
+frames = 60
+for i in range(1, n, int(n/frames)):
+    # Changes the range of the data each step to make it look like a time series
+    plot_(x[0: i], y[0: i])
+
+# Create gif
+gif.create_gif()

examples/example_1_option2.py

@@ -0,0 +1,30 @@
+import numpy as np
+import plotly.graph_objs as go
+from plotly_gif import GIF
+
+
+# create_gif some data
+n = 100
+x = np.linspace(0, n-1, n)
+y = np.sin(x) + np.random.rand(n)
+
+# Create gif class to store data
+gif = GIF(verbose=True)
+
+
+def plot_(x_, y_):
+    # Function that generates  plotly figures
+    fig = go.Figure()
+    fig.add_trace(go.Scatter(x=x_, y=y_, mode="lines"))
+
+    gif.create_image(fig)  # tells gif to save each figure
+    return fig
+
+
+frames = 60
+for i in range(1, n, int(n/frames)):
+    # Changes the range of the data each step to make it look like a time series
+    plot_(x[0: i], y[0: i])
+
+# Function that generates new plotly figures
+gif.create_gif()

examples/example_1_short.py

@@ -0,0 +1,22 @@
+import numpy as np
+import plotly.graph_objs as go
+from plotly_gif import GIF, two_d_time_series
+
+
+# create_gif some data
+n = 100
+x = np.linspace(0, n-1, n)
+y = np.sin(x) + np.random.rand(n)
+
+# create and format plot just the way you like!
+fig = go.Figure()
+fig.add_trace(go.Scatter(x=x, y=y, mode="lines"))
+fig.update_layout(layout)
+fig.update_xaxes(xaxis)
+fig.update_yaxes(yaxis)
+
+# create gif class to store data
+gif = GIF(verbose=True)
+
+# send it to built-in function that will generate gif time_series.
+two_d_time_series(gif, fig)

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+    ]
+build-backend = "setuptools.build_meta"

requirements.txt

@@ -0,0 +1,3 @@
+Pillow==9.0.0
+plotly==5.5.0
+kaleido==0.2.1

setup.cfg

@@ -24,5 +24,8 @@ package_dir =
     =src
 zip_safe = no
 include_package_data = true
-
+install_requires =
+    Pillow>=9.0.0
+    plotly>=5.5.0
+    kaleido>=0.2.1
 

src/plotly_gif/__init__.py

@@ -0,0 +1,31 @@
+from functools import wraps
+import logging
+
+from .gif import GIF
+from .two_d_plots import two_d_time_series
+from .three_d_plots import three_d_scatter_rotate
+
+level = logging.INFO
+logging.basicConfig(level=level, format='  %(message)s')
+
+
+def capture(gif_: GIF):
+    """ Capture
+    Captures images as they are created.
+
+    Parameters
+    ----------
+    gif_: GIF
+        gif object that stores images
+
+    """
+    def capture_decorator(func):
+        @wraps(func)
+        def _capture(*args, **kwargs):
+            fig = func(*args, **kwargs)
+            gif_.create_image(fig)
+            return fig
+
+        return _capture
+
+    return capture_decorator

src/plotly_gif/_format.py

@@ -0,0 +1,43 @@
+# Just trying to make the plots look nice!! :)
+layout = {
+        "autosize": False,
+        "width": 800,
+        "height": 600,
+        "showlegend": False,
+        "font": dict(family="Arial", size=18, color="black"),
+        "plot_bgcolor": "white"
+}
+
+xaxis = {
+    "title": "<b>X<b>",
+    "tickprefix": "<b>",
+    "ticksuffix": "</b>",
+    "showline": True,
+    "linewidth": 5,
+    "mirror": True,
+    "linecolor": 'black',
+    "ticks": "outside",
+    "tickwidth": 4,
+    "showgrid": False,
+    "gridwidth": 1,
+    "gridcolor": 'lightgray'
+}
+
+yaxis = {
+    "title": "<b>Y<b>",
+    "tickprefix": "<b>",
+    "ticksuffix": "</b>",
+    "showline": True,
+    "linewidth": 5,
+    "mirror": True,
+    "linecolor": 'black',
+    "ticks": "outside",
+    "tickwidth": 4,
+    "showgrid": False,
+    "gridwidth": 1,
+    "gridcolor": 'lightgray'
+}
+
+fig.update_layout(layout)
+fig.update_xaxes(xaxis)
+fig.update_yaxes(yaxis)