A module for Wagtail that provides functionality similar to wagtail.wagtaildocs module,
but for audio and video files.
wagtailmedia is compatible with Wagtail 1.6 and above.
Install using pip:
pip install wagtailmedia
In your settings file, add wagtailmedia to INSTALLED_APPS:
INSTALLED_APPS = [
# ...
'wagtailmedia',
# ...
]Your project needs to be set up to serve user-uploaded files from MEDIA_ROOT.
Your Django project may already have this in place, but if not, add the following snippet to urls.py:
from django.conf import settings
from django.conf.urls.static import static
urlpatterns = [
# ... the rest of your URLconf goes here ...
] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)Note that this only works in development mode (DEBUG = True);
in production, you will need to configure your web server to serve files from MEDIA_ROOT.
For further details, see the Django documentation: Serving files uploaded by a user during development
and Deploying static files.
With this configuration in place, you are ready to run ./manage.py migrate to create the database tables used by wagtailmedia.
The Media model can be customised. To do this, you need
to add a new model to your project that inherits from wagtailmedia.models.AbstractMedia.
Then set the WAGTAILMEDIA_MEDIA_MODEL setting to point to it:
WAGTAILMEDIA_MEDIA_MODEL = 'mymedia.CustomMedia'You can use Media in StreamField. To do this, you need
to add a new block class that inherits from wagtailmedia.blocks.AbstractMediaChooserBlock
and implement your own render_basic method.
Here is an example:
from __future__ import unicode_literals
from django.db import models
from django.utils.html import format_html
from wagtail.wagtailcore.models import Page
from wagtail.wagtailcore.fields import StreamField
from wagtail.wagtailcore import blocks
from wagtail.wagtailadmin.edit_handlers import FieldPanel, StreamFieldPanel
from wagtailmedia.blocks import AbstractMediaChooserBlock
class TestMediaBlock(AbstractMediaChooserBlock):
def render_basic(self, value, context=None):
if not value:
return ''
if value.type == 'video':
player_code = '''
<div>
<video width="320" height="240" controls>
<source src="{0}" type="video/mp4">
Your browser does not support the video tag.
</video>
</div>
'''
else:
player_code = '''
<div>
<audio controls>
<source src="{0}" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
</div>
'''
return format_html(player_code, value.file.url)
class BlogPage(Page):
author = models.CharField(max_length=255)
date = models.DateField("Post date")
body = StreamField([
('heading', blocks.CharBlock(classname="full title", icon='title')),
('paragraph', blocks.RichTextBlock(icon='pilcrow')),
('media', TestMediaBlock(icon='media')),
])
content_panels = Page.content_panels + [
FieldPanel('author'),
FieldPanel('date'),
StreamFieldPanel('body'),
]Also, you can use Media as a regular Django field.
Example
from __future__ import unicode_literals
from django.db import models
from wagtail.wagtailcore.models import Page
from wagtail.wagtailcore.fields import RichTextField
from wagtail.wagtailadmin.edit_handlers import FieldPanel
from wagtailmedia.edit_handlers import MediaChooserPanel
class BlogPageWithMedia(Page):
author = models.CharField(max_length=255)
date = models.DateField("Post date")
body = RichTextField(blank=False)
media = models.ForeignKey(
'wagtailmedia.Media',
null=True,
blank=True,
on_delete=models.SET_NULL,
related_name='+'
)
content_panels = Page.content_panels + [
FieldPanel('author'),
FieldPanel('date'),
FieldPanel('body'),
MediaChooserPanel('media'),
]To run tests you need to clone this repository:
git clone https://github.com/torchbox/wagtailmedia.git
cd wagtailmedia
With your preferred virtualenv activated, install testing dependencies:
pip install -e .[testing] -U
Now you can run tests as shown below:
python runtests.py