Skip to content

Latest commit

 

History

History
109 lines (68 loc) · 3.18 KB

README.md

File metadata and controls

109 lines (68 loc) · 3.18 KB

License PyPI version Code Issues

embedX

Generate embeddable HTML or JavaScript code for a online content from its URL in a single step.

The content can be anything like

  • Youtube or Vimeo video,
  • Twitter status,
  • Github Gist, etc.

Embeddable code-generation be simple like this:

>>> from embed_x import OnlineContent
>>> oc = OnlineContent('http://www.youtube.com/embed/_lOT2p_FCvA')
>>> oc.get_embed_code()
"<div class='embedx-yt'><iframe src='http://www.youtube.com/embed/_lOT2p_FCvA' 'frameborder='0' allowfullscreen></iframe></div>"

Currently, supports

  • Youtube video,
  • Vimeo video,
  • Twitter: single status,
  • Github gist,
  • Flickr image

Examples of URLs

Valid

Invalid:

Install

from PyPI

pip install embedx

Directly from source

pip install git+https://github.com/kmonsoor/embedX.git

Requirements

This library don't have any external dependencies other than standard Python installation.

Usage

>>> from embedx import OnlineContent
>>> oc = OnlineContent('http://www.youtube.com/embed/_lOT2p_FCvA')
>>> oc.extract_id()
'_lOT2p_FCvA'

>>> oc.get_embed_code()
"<div class='embed-container'><iframe src='http://www.youtube.com/embed/_lOT2p_FCvA' 'frameborder='0'allowfullscreen></iframe></div>"

>>> oc = OnlineContent('https://vimeo.com/groups/animation/videos/150618894/')
>>> oc.get_embed_code()
"<div class='embed-container'> <iframe src='http://player.vimeo.com/video/150618894' frameborder='0' webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe></div>"

To-do

  • Create test cases for automated testing

  • Provision Travis-CI for automatic building & testing

  • Add support for conda-based installation

  • Add more rich-content sites

    • Github gists
    • Facebook status
    • Facebook notes
    • Scribd docs
    • Imgur images

Contributors

Please try to contribute by submitting more content-sites with their different link formats and embed-codes. You can submit through pull-requests or by creating issue.