Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Adding example to the readme

  • Loading branch information...
commit 7cabc54c5dbc0bc2a1108bcf08ea4cf4805d76fa 1 parent 328d751
@coleifer authored
Showing with 50 additions and 0 deletions.
  1. +50 −0 README.rst
View
50 README.rst
@@ -4,3 +4,53 @@ micawber
.. image:: http://i.imgur.com/QAnaa.jpg
A small library for extracting rich content from urls
+
+
+what does it do?
+----------------
+
+micawber supplies a few methods for retrieving rich metadata about a variety of
+links, such as links to youtube videos. micawber also provides functions for
+parsing blocks of text and html and replacing links to videos with rich embedded
+content.
+
+examples
+--------
+
+here is a quick example::
+
+ import micawber
+
+ # load up rules for some default providers, such as youtube and flickr
+ providers = micawber.bootstrap_basic()
+
+ providers.request('http://www.youtube.com/watch?v=54XHDUOHuzU')
+
+ # returns the following dictionary:
+ {
+ 'author_name': 'pascalbrax',
+ 'author_url': u'http://www.youtube.com/user/pascalbrax'
+ 'height': 344,
+ 'html': u'<iframe width="459" height="344" src="http://www.youtube.com/embed/54XHDUOHuzU?fs=1&feature=oembed" frameborder="0" allowfullscreen></iframe>',
+ 'provider_name': 'YouTube',
+ 'provider_url': 'http://www.youtube.com/',
+ 'title': 'Future Crew - Second Reality demo - HD',
+ 'type': u'video',
+ 'thumbnail_height': 360,
+ 'thumbnail_url': u'http://i2.ytimg.com/vi/54XHDUOHuzU/hqdefault.jpg',
+ 'thumbnail_width': 480,
+ 'url': 'http://www.youtube.com/watch?v=54XHDUOHuzU',
+ 'width': 459,
+ 'version': '1.0',
+ }
+
+ micawber.parse_text('this is a test:\nhttp://www.youtube.com/watch?v=54XHDUOHuzU', providers)
+
+ # returns the following string:
+ this is a test:
+ <iframe width="459" height="344" src="http://www.youtube.com/embed/54XHDUOHuzU?fs=1&feature=oembed" frameborder="0" allowfullscreen></iframe>
+
+ micawber.parse_html('<p>http://www.youtube.com/watch?v=54XHDUOHuzU</p>', providers)
+
+ # returns the following html:
+ <p><iframe width="459" height="344" src="http://www.youtube.com/embed/54XHDUOHuzU?fs=1&amp;feature=oembed" frameborder="0" allowfullscreen="allowfullscreen"></iframe></p>
Please sign in to comment.
Something went wrong with that request. Please try again.