Merge branch 'master' into master

arraystream · web-flow · commit db2f01c56ad6 · 2017-03-31T11:13:48.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,14 @@
+language: python
+
+python:
+  - "3.4"
+  - "3.5"
+  - "3.6"
+
+install:
+  - pip install --upgrade pip
+  - pip install --upgrade setuptools wheel
+  - pip install --upgrade pytest
+  - pip install --upgrade plotly
+
+script: pytest
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
-## simpleplotly
-##### An easy to use plotly wrapper for python / jupyter notebooks
+## SimplePlotly
+
+[![PyPI Version](https://img.shields.io/pypi/v/simpleplotly.svg)](https://pypi.python.org/pypi/simpleplotly) [![Build Status](https://travis-ci.org/arraystream/simpleplotly.svg?branch=master)](https://travis-ci.org/arraystream/simpleplotly)
+
+SimplePlotly is an easy to use plotly wrapper for python / jupyter notebooks
 
 ### Authors
 
@@ -10,7 +13,7 @@ ArrayStream (Yu Zheng, Ran Fan, Yongxin Yang)
 
 ### Documentation
 
-Please see our blog post on: [http://www.arraystream.com/blog/simpleplotly](http://www.arraystream.com/blog/simpleplotly)
+Please see our blog post on: [http://www.arraystream.com/blog/simpleplotly.html](http://www.arraystream.com/blog/simpleplotly.html)
 
 ### Contributing
 
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md
diff --git a/setup.py b/setup.py
@@ -1,18 +1,26 @@
 # -*- coding: utf-8 -*-
 
+import sys
+
 from setuptools import setup, find_packages
 
 exec(open('simpleplotly/version.py').read())
 
 
+def check_python_version():
+    if sys.version_info[:2] < (3, 4):
+        print('Python 3.4 or newer is required. Python version detected: {}'.format(sys.version_info))
+        sys.exit(-1)
+
+
 def main():
     setup(name='simpleplotly',
           version=__version__,
-          author='ArrayStream',
+          author='ArrayStream (Yu Zheng, Ran Fan, Yongxin Yang)',
           author_email='team@arraystream.com',
           url='https://github.com/arraystream/simpleplotly',
-          description="simpleplotly makes generating charts with plotly easy",
-          long_description=__doc__,
+          description='An easy to use plotly wrapper for python / jupyter notebooks',
+          long_description='simpleplotly makes generating charts with plotly easy',
           classifiers=[
               'Development Status :: 4 - Beta',
               'Programming Language :: Python :: 3',
@@ -28,4 +36,5 @@ def main():
 
 
 if __name__ == '__main__':
+    check_python_version()
     main()
diff --git a/simpleplotly/__init__.py b/simpleplotly/__init__.py
@@ -4,6 +4,13 @@
     FigureBuilder,
     FigureHolder,
 )
+from .layout import (
+    Annotation,
+    Shape,
+    XAxis,
+    YAxis,
+    ZAxis,
+)
 from .plot import (
     Scatter,
     Line,
@@ -15,10 +22,4 @@
     Line3D,
     Surface,
 )
-from .layout import (
-    Annotation,
-    Shape,
-    XAxis,
-    YAxis,
-    ZAxis,
-)
+from .version import __version__
diff --git a/simpleplotly/figure.py b/simpleplotly/figure.py
@@ -1,12 +1,13 @@
 # -*- coding: utf-8 -*-
 
+import itertools
+
 import plotly.graph_objs as go
 from plotly import tools
 import copy
 from .layout import ElementBuilder
 from .plot import AtomBuilder
 from .subplot import SubPlotSpec, PlotCanvas
-import itertools
 
 
 class FigureHolder(object):
@@ -24,33 +25,34 @@ def update_layout(self, **kwargs):
         self.figure.layout.update(**kwargs)
         return self
 
-    def drop_key_layout(self, key):
+    def drop_layout_key(self, key):
         if key in self.figure.layout:
             del self.figure.layout[key]
         return self
 
 
 class FigureBuilder(object):
-    def __init__(self, *builders):
-        self.builders = list(builders)
-        self.specs = [None for _ in range(len(builders))]
+    def __init__(self):
+        self.builders = []
+        self.specs = []
         self.layout = {}
         self.canvas = PlotCanvas()
 
-    def __add__(self,fig_builder,default_layout='blank'):
-        # new builder
+    def __add__(self, other_builder):
+        return self.combine(other_builder)
+
+    def combine(self, other_builder, layout=None):
         new_fig_builder = FigureBuilder()
         new_fig_builder.builders.extend(self.builders)
-        new_fig_builder.builders.extend(fig_builder.builders)
-        if default_layout=='left':
-            new_fig_builder.layout=self.layout
-        elif default_layout=='right':
-            new_fig_builder.layout=fig_builder.layout
-        else:
-            new_fig_builder.layout={}
+        new_fig_builder.builders.extend(other_builder.builders)
+        if layout == 'left':
+            new_fig_builder.layout = self.layout
+        elif layout == 'right':
+            new_fig_builder.layout = other_builder.layout
+        elif layout is not None:
+            raise ValueError('layout can only be left, right or None')
         return new_fig_builder
 
-
     def add(self, builder, row=None, col=None, row_span=1, col_span=1):
         if isinstance(builder, AtomBuilder):
             self.builders.append(builder)
@@ -98,7 +100,7 @@ def build_subplot(self, print_grid=True, **kwargs):
 
         holder = FigureHolder(go.Figure(data=fig.data, layout=fig.layout))
         holder.update_layout(**self.layout)
-        holder.drop_key_layout('xaxis').drop_key_layout('yaxis')
+        holder.drop_layout_key('xaxis').drop_layout_key('yaxis')
         return holder
 
     def subplot(self, row=None, col=None, print_grid=True, **kwargs):
diff --git a/simpleplotly/layout.py b/simpleplotly/layout.py
@@ -54,15 +54,15 @@ def __call__(self, layout):
 
 
 class XAxis(AxisBuilder):
-    def __init__(self, title, name='xaxis', autorange=True, showgrid=True, zeroline=True, showline=False, **kwargs):
-        super().__init__(go.XAxis, name=name, title=title, autorange=autorange, showgrid=showgrid, zeroline=zeroline, showline=showline, **kwargs)
+    def __init__(self, title, autorange=True, showgrid=True, zeroline=True, showline=False, **kwargs):
+        super().__init__(go.XAxis, name='xaxis', title=title, autorange=autorange, showgrid=showgrid, zeroline=zeroline, showline=showline, **kwargs)
 
 
 class YAxis(AxisBuilder):
-    def __init__(self, title, name='yaxis', autorange=True, showgrid=True, zeroline=True, showline=False, **kwargs):
-        super().__init__(go.YAxis, title=title, name=name, autorange=autorange, showgrid=showgrid, zeroline=zeroline, showline=showline, **kwargs)
+    def __init__(self, title, autorange=True, showgrid=True, zeroline=True, showline=False, **kwargs):
+        super().__init__(go.YAxis, title=title, name='yaxis', autorange=autorange, showgrid=showgrid, zeroline=zeroline, showline=showline, **kwargs)
 
 
 class ZAxis(AxisBuilder):
-    def __init__(self, title, name='zaxis', autorange=True, showgrid=True, zeroline=True, showline=False, **kwargs):
-        super().__init__(go.ZAxis, title=title, name=name, autorange=autorange, showgrid=showgrid, zeroline=zeroline, showline=showline, **kwargs)
+    def __init__(self, title, autorange=True, showgrid=True, zeroline=True, showline=False, **kwargs):
+        super().__init__(go.ZAxis, title=title, name='zaxis', autorange=autorange, showgrid=showgrid, zeroline=zeroline, showline=showline, **kwargs)
diff --git a/simpleplotly/version.py b/simpleplotly/version.py
@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.0.1'
+__version__ = '0.0.5'
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-
diff --git a/tests/test_figure.py b/tests/test_figure.py
@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+
+import unittest
+import simpleplotly as sp
+import plotly.graph_objs as go
+
+
+class FigureHolderTest(unittest.TestCase):
+    def test_can_update_layout(self):
+        fh = sp.FigureHolder(go.Figure())
+        fh.update_layout(barmode='group', title='test plot')
+        self.assertDictEqual(fh.figure.layout, dict(barmode='group', title='test plot'))
+
+        fh.drop_layout_key('barmode')
+        self.assertDictEqual(fh.figure.layout, dict(title='test plot'))
+
+
+class FigureBuilderTest(unittest.TestCase):
+    def test_figure_builder_operations(self):
+        pass
diff --git a/tests/test_layout.py b/tests/test_layout.py
@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+
+import unittest
+
+import simpleplotly as sp
+
+
+class LayoutBuildersTest(unittest.TestCase):
+    def setUp(self):
+        self.test_layout = {}
+
+    def test_shape_builder(self):
+        expected = {'type': 'rect', 'x0': 2, 'x1': 3, 'xref': 'x', 'y0': 0, 'y1': 1, 'yref': 'paper'}
+        shape_builder = sp.Shape(**expected)
+        shape_builder(self.test_layout)
+        self.assertDictEqual(self.test_layout['shapes'][0], expected)
+
+    def test_annotation_builder(self):
+        expected = {'text': 'some text', 'x': 2, 'xref': 'x', 'y': 3, 'yref': 'y'}
+        annotation_builder = sp.Annotation(2, 3, 'some text')
+        annotation_builder(self.test_layout)
+        self.assertDictEqual(self.test_layout['annotations'][0], expected)
+
+    def test_xaxis_builder(self):
+        self.check_axis(sp.XAxis, 'xaxis')
+
+    def test_yaxis_builder(self):
+        self.check_axis(sp.YAxis, 'yaxis')
+
+    def test_zaxis_builder(self):
+        self.check_axis(sp.ZAxis, 'zaxis')
+
+    def check_axis(self, axis_builder_func, axis_name):
+        expected = {'autorange': True, 'showgrid': True, 'showline': False, 'title': 'test axis', 'zeroline': True}
+        shape_builder = axis_builder_func('test axis')
+        shape_builder(self.test_layout)
+        self.assertDictEqual(self.test_layout[axis_name], expected)
diff --git a/tests/test_subplot.py b/tests/test_subplot.py
@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[metadata]`
	`2`	`+description-file = README.md`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`# -- coding: utf-8 --`
`2`	`2`
`3`		`-__version__ = '0.0.1'`
	`3`	`+__version__ = '0.0.5'`