Merge pull request #3200 from 3kwa/master

add base IFrame class, and YouTubeVideo siblings, VimeoVideo and ScribdDocument

IPython/lib/display.py

@@ -6,7 +6,40 b' from os.path import exists, isfile, splitext, abspath, join, isdir'
 from os import walk, sep
 
 
-class YouTubeVideo(object):
+class IFrame(object):
+    """
+    Generic class to embed an iframe in an IPython notebook
+    """
+
+    iframe = """
+        <iframe
+            width="{width}"
+            height={height}"
+            src="{src}{params}"
+            frameborder="0"
+            allowfullscreen
+        ></iframe>
+        """
+
+    def __init__(self, src, width, height, **kwargs):
+        self.src = src
+        self.width = width
+        self.height = height
+        self.params = kwargs
+
+    def _repr_html_(self):
+        """return the embed iframe"""
+        if self.params:
+            from urllib import urlencode
+            params = "?" + urlencode(self.params)
+        else:
+            params = ""
+        return self.iframe.format(src=self.src,
+                                  width=self.width,
+                                  height=self.height,
+                                  params=params)
+
+class YouTubeVideo(IFrame):
     """Class for embedding a YouTube Video in an IPython session, based on its video id.
 
     e.g. to embed the video on this page:
@@ -31,27 +64,33 b' class YouTubeVideo(object):'
     """
 
     def __init__(self, id, width=400, height=300, **kwargs):
-        self.id = id
-        self.width = width
-        self.height = height
-        self.params = kwargs
+        src = "http://www.youtube.com/embed/{0}".format(id)
+        super(YouTubeVideo, self).__init__(src, width, height, **kwargs)
 
-    def _repr_html_(self):
-        """return YouTube embed iframe for this video id"""
-        if self.params:
-            from urllib import urlencode  # Deferred import
-            params = "?" + urlencode(self.params)
-        else:
-            params = ""
-        return """
-            <iframe
-                width="%i"
-                height="%i"
-                src="http://www.youtube.com/embed/%s%s"
-                frameborder="0"
-                allowfullscreen
-            ></iframe>
-        """ % (self.width, self.height, self.id, params)
+class VimeoVideo(IFrame):
+    """
+    Class for embedding a Vimeo video in an IPython session, based on its video id.
+    """
+
+    def __init__(self, id, width=400, height=300, **kwargs):
+        src="http://player.vimeo.com/video/{0}".format(id)
+        super(VimeoVideo, self).__init__(src, width, height, **kwargs)
+
+class ScribdDocument(IFrame):
+    """
+    Class for embedding a Scribd document in an IPython session
+
+    Use the start_page params to specify a starting point in the document
+    Use the view_mode params to specify display type one off scroll | slideshow | book
+
+    e.g to Display Wes' foundational paper about PANDAS in book mode from page 3
+
+    ScribdDocument(71048089, width=800, height=400, start_page=3, view_mode="book")
+    """
+
+    def __init__(self, id, width=400, height=300, **kwargs):
+        src="http://www.scribd.com/embeds/{0}/content".format(id)
+        super(ScribdDocument, self).__init__(src, width, height, **kwargs)
 
 class FileLink(object):
     """Class for embedding a local file link in an IPython session, based on path