Skip to main content

OEmbed anything.

Project description

feincms-oembed converts standard URLs from more than 200 content providers into embedded videos, images and rich article previews by letting Embedly or another OEmbed provider to the hard work.

It’s stunningly simple to use:

  1. Add 'feincms_oembed' to INSTALLED_APPS.

  2. Create the content type:

    from feincms.module.page.models import Page
    from feincms_oembed.contents import OembedContent
    
    TYPE_CHOICES = [
        ('default', _('Default presentation'), {
            'maxwidth': 500, 'maxheight': 300, 'wmode': 'opaque'}),
        ('transparent', _('Transparent'), {
            'maxwidth': 500, 'maxheight': 300, 'wmode': 'transparent'}),
        ]
    
    Page.create_content_type(OembedContent, TYPE_CHOICES=TYPE_CHOICES)

You can also specify additional parameters which are sent to the OEmbed provider too:

Page.create_content_type(OembedContent, TYPE_CHOICES=TYPE_CHOICES,
    PARAMS={'wmode': 'opaque', 'key': settings.EMBEDLY_KEY})

If you want to customize the Embedly request or use another OEmbed provider, set settings.OEMBED_PROVIDER to a function receiving the URL and a dict with additional arguments and returning a suitable URL which returns OEmbed JSON on access. OEMBED_PROVIDER must either be a dotted python path or a callable:

from feincms_oembed.providers import embedly_oembed_provider
def my_provider(url, kwargs):
    kwargs['wmode'] = 'opaque'
    return embedly_oembed_provider(url, kwargs)

OEMBED_PROVIDER = 'path.to.module.my_provider'
# OEMBED_PROVIDER = my_provider # The function can be used too, not only
                                # the dotted python path.

The content is looking for templates in the following order in the folder content/external/:

  1. type of the embedded object (e.g. ‘video’) + .html

  2. type of the content type (e.g. ‘transparent’) + .html

  3. default.html

If you don’t want any surprises with blocked access to Embedly it is suggested that you register for a free API key.

Using the FeedContent

If you want to use the FeedContent, make sure you have feedparser in your Python path.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

feincms-oembed-1.3.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

feincms_oembed-1.3.0-py2.py3-none-any.whl (15.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file feincms-oembed-1.3.0.tar.gz.

File metadata

File hashes

Hashes for feincms-oembed-1.3.0.tar.gz
Algorithm Hash digest
SHA256 2d582d4f0bdf955c2b08b986e7a148fc649f68d08793a03f64dfc25d6818db03
MD5 865fbb4a56519fdd916f546956518525
BLAKE2b-256 1bdf6f6c40a8c032915b19f329b5ea41c9648fbdcdc77be89b1aed539996a0ee

See more details on using hashes here.

File details

Details for the file feincms_oembed-1.3.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for feincms_oembed-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d6da75508b7029f1b71d717cfb9c9e0b16dfd3181741989beebadb13eb87623a
MD5 5a9bd795c0fb2f5226b918bf1de7e2fd
BLAKE2b-256 b390538bd5235b341c4a9475f2f500f391144e29971a45d974ddb25b6d3d523d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page