Skip to main content

DjangoCMS YouTube video embed plugin with minimal impact

Project description

djangocms-youtube-lazyload

https://pypi.org/project/djangocms-youtube-lazyload/ https://travis-ci.com/github/jeroenpeters1986/djangocms-youtube-lazyload PyPI - Status PyPI - License PyPI - Downloads

Speed up your pageloads with this YouTube embed plugin for your Django CMS powered site. It requires a (free) YouTube Data API Key.

Quickstart

  1. Install djangocms-youtube:
    pip install djangocms-youtube-lazyload
    
  2. Add djangocms_youtube_lazyload to INSTALLED_APPS:
    INSTALLED_APPS = (
        ...
        'djangocms_youtube_lazyload',
        ...
    )
    
  3. Sync database :
    python manage.py migrate
    
  4. Collect static files to make sure you can edit your videos with Django CMS
    python manage.py collectstatic
    
  5. Plugin requires Server API key to be able to use the YouTube Data API
    DJANGOCMS_YOUTUBE_LAZYLOAD_API_KEY = '<youtube_data_api_server_key>'
    
    Instructions on how to obtain an API key are located here: https://developers.google.com/youtube/registering_an_application

This Youtube plugin reduces Page Load Time

When you embed any YouTube video on your website using standard IFRAME tags, you’ll be surprised to know how much extra weight that YouTube video will add to your page. The resources (CSS, images and JavaScript) will download even if the visitor on your website has chosen not to watch the embedded YouTube video. This will noticably slow down your page.

djangocms-youtube-lazyload uses a clever workaround to reduce the time it would normally take to initially load the YouTube video player. Instead of embedding the full Youtube video player, which also takes a big on your requests and data-loading, it displays just the thumbnail images of the video and a 'play' icon is placed over the video so that it looks like a video player.

When the user hits the play button, the video thumbnail is replaced with the standard YouTube video player. The extra resources are thus loaded only when the user has decided to play the embedded video and not otherwise.

Note: Mobile devices require two taps to play the video. Tap the image once to remove it and display the video player. Then, tap the play button to begin the video.

Schema.org Integration

Full support for schema.org videoObject markup.

<div class="video-wrapper" itemprop="video" itemscope="" itemtype="http://schema.org/VideoObject">
    <meta itemprop="name" content="PSY - GANGNAM STYLE (강남스타일) M/V">
    <meta itemprop="duration" content="PT4M13S">
    <meta itemprop="thumbnailUrl" content="https://i.ytimg.com/vi/9bZkp7q19f0/maxresdefault.jpg">
    <meta itemprop="embedURL" content="https://www.youtube.com/embed/9bZkp7q19f0">
    <meta itemprop="uploadDate" content="2012-07-15T07:46:32.000Z">
    <meta itemprop="height" content="480">
    <meta itemprop="width" content="853">
    <meta itemprop="description" content="...">
</div>

See https://developers.google.com/webmasters/videosearch/schema

Video Endscreen

Plugin can have child plugins (i.e other plugins placed inside this plugin), rendered as an overlay, when the video finishes. You can disable this functionality by overriding DJANGOCMS_YOUTUBE_LAZYLOAD_ALLOW_CHILDREN in your settings.py file

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

djangocms-youtube-lazyload-1.0.7.tar.gz (139.4 kB view details)

Uploaded Source

File details

Details for the file djangocms-youtube-lazyload-1.0.7.tar.gz.

File metadata

  • Download URL: djangocms-youtube-lazyload-1.0.7.tar.gz
  • Upload date:
  • Size: 139.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.6.8

File hashes

Hashes for djangocms-youtube-lazyload-1.0.7.tar.gz
Algorithm Hash digest
SHA256 f92596495fd0448acf7fb35c8df0c830d7b11766bb827e1832b272db9e9b76bb
MD5 12a67031a8416f05f4fb5b497800204a
BLAKE2b-256 873da6a23c83c400f8f44edd919d02a7371e85333a829dcac694462493e6d6a0

See more details on using hashes here.

Supported by

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