Real-time streaming support, version bump

chriddyp · chriddyp · commit 39626f7652f4 · 2014-03-07T21:18:00.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,7 @@
 Untitled0.ipynb
 
 *.ipynb
+
+build
+
+dist
diff --git a/plotly/__init__.py b/plotly/__init__.py
@@ -2,4 +2,5 @@
 from .plotly import signup
 from .plotly import display
 from .plotly import embed
-from .plotly import plotly
+from .plotly import plotly
+from .plotly import stream
diff --git a/plotly/plotly.py b/plotly/plotly.py
@@ -1,6 +1,7 @@
 import requests
 import json
 import warnings
+import httplib
 
 from .version import __version__
 
@@ -250,5 +251,53 @@ def __makecall(self, args, un, key, origin, kwargs):
 			
 		return r
 
+class stream:
+	def __init__(self, token):
+		''' plotly stream constructor
+		token found at https://plot.ly/settings
+		'''
+		self.token = token
+		self.connected = False
+
+	def init(self):
+		''' Initialize a streaming connection to plotly        
+		'''
+		self.conn = httplib.HTTPConnection('stream.plot.ly', 80)
+		self.conn.putrequest('POST', '/')
+		self.conn.putheader('Host', 'stream.plot.ly')
+		self.conn.putheader('User-Agent', 'Python-Plotly')
+		self.conn.putheader('Transfer-Encoding', 'chunked')
+		self.conn.putheader('Connection', 'close')
+		self.conn.putheader('plotly-streamtoken', self.token)
+		self.conn.endheaders()
+		self.connected=True
+
+	def write(self, data):
+		''' Write data to plotly's streaming servers
 
+		data is a plotly formatted data dict
+		with data keys 'x', 'y', 'text', 'z', 'marker', 'line'
+		'x', 'y', 'text', and 'z' can have values of strings, numbers, or lists
+		'marker', and 'line' have dicts as values with keys 'size', 'color', 'symbol'
 
+		Examples:
+		{'x': 1, 'y': 2}
+		{'x': [1, 2, 3], 'y': [10, 20, 30]}
+		{'x': 1, 'y': 3, 'text': 'hover text'}
+		{'x': 1, 'y': 3, 'marker': {'color': 'blue'}}
+		{'z': [[1,2,3], [4,5,6]]}
+		'''
+		if not self.connected:
+			self.init()
+		# plotly's streaming API takes new-line separated json objects
+		msg = json.dumps(data)+'\n'
+		msglen = format(len(msg), 'x')
+		# chunked encoding requests contain the messege length in hex, \r\n, and then the message
+		self.conn.send('{msglen}\r\n{msg}\r\n'.format(msglen=msglen, msg=msg))
+
+	def close(self):
+		''' Close connection to plotly's streaming servers
+		'''
+		self.conn.send('0\r\n\r\n')
+		self.conn.close()
+		self.connected=False
diff --git a/plotly/version.py b/plotly/version.py
@@ -1 +1 @@
-__version__ = '0.5.10'
+__version__ = '0.5.11'
diff --git a/setup.py b/setup.py
@@ -1,23 +1,26 @@
 from setuptools import setup
 exec(open('plotly/version.py').read())
+
 def readme():
 	with open('README.txt') as f:
 		return f.read()
 
 setup(name='plotly',
       version=__version__,
+      use_2to3=True,
       author='Chris P',
       author_email='chris@plot.ly',
       maintainer='Chris P',
       maintainer_email='chris@plot.ly',
       url='https://plot.ly/api/python',
       description='Python plotting library for collaborative, interactive, web-based, publication-quality graphs.', 
       long_description=readme(),
-      classifiers=['Development Status :: 4 - Beta',
-      'Programming Language :: Python :: 2.7',
-      'Programming Language :: Python :: 3.3',      
-      'Topic :: Scientific/Engineering :: Visualization',
-	  ],
+      classifiers=[
+            'Development Status :: 4 - Beta',
+            'Programming Language :: Python :: 2.7',
+            'Programming Language :: Python :: 3.3',      
+            'Topic :: Scientific/Engineering :: Visualization',
+	],
       license='MIT',
       packages=['plotly'],
       install_requires=[

-Original file line number
+Diff line change
 Untitled0.ipynb
 *.ipynb
++
 +build
++
 +dist
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = '0.5.10'`
	`1`	`+__version__ = '0.5.11'`