Metadata-Version: 2.1
Name: wagtailvideos
Version: 2.8.2
Summary: A wagtail module for uploading and displaying videos in various codecs.
Home-page: https://github.com/neon-jungle/wagtailvideos
Author: Neon Jungle
Author-email: developers@neonjungle.studio
License: BSD License
Description: wagtailvideos
        =============
        
        Based on wagtailimages. The aim was to have feature parity with images
        but for html5 videos. Includes the ability to transcode videos to a
        html5 compliant codec using ffmpeg.
        
        Requirements
        ------------
        
        -  Wagtail >= 2.4
        -  `ffmpeg <https://ffmpeg.org/>`__
        
        Installing
        ----------
        
        Install using pypi
        
        .. code:: bash
        
            pip install wagtailvideos
        
        
        Using
        -----
        
        On a page model:
        ~~~~~~~~~~~~~~~~
        
        Implement as a ``ForeignKey`` relation, same as wagtailimages.
        
        .. code:: python
        
        
            from django.db import models
        
            from wagtail.wagtailadmin.edit_handlers import FieldPanel
            from wagtail.wagtailcore.fields import RichTextField
            from wagtail.wagtailcore.models import Page
        
            from wagtailvideos.edit_handlers import VideoChooserPanel
        
            class HomePage(Page):
                body = RichtextField()
                header_video = models.ForeignKey('wagtailvideos.Video',
                                                 related_name='+',
                                                 null=True,
                                                 on_delete=models.SET_NULL)
        
                content_panels = Page.content_panels + [
                    FieldPanel('body'),
                    VideoChooserPanel('header_video'),
                ]
        
        In template:
        ~~~~~~~~~~~~
        
        The video template tag takes one required postitional argument, a video
        field. All extra attributes are added to the surrounding ``<video>``
        tag. The original video and all extra transcodes are added as
        ``<source>`` tags.
        
        .. code:: django
        
            {% load wagtailvideos_tags %}
            {% video self.header_video autoplay controls width=256 %}
        
        How to transcode using ffmpeg:
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Using the video collection manager from the left hand menu. In the video
        editing section you can see the available transcodes and a form that can
        be used to create new transcodes. It is assumed that your compiled
        version of ffmpeg has the matching codec libraries required for the
        transcode.
        
        Future features
        ---------------
        
        -  Richtext embed
        -  Streamfield block
        -  Transcoding via amazon service rather than ffmpeg
        -  Wagtail homescreen video count
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: BSD License
Provides-Extra: testing
