Commit 9b5b8662 authored by Seb's avatar Seb
Browse files

Fix for wrong method signature syntax, bump version, converted readme to rst for pypi

parent 2b471aa5
include LICENSE
include README.md
include README.rst
recursive-include wagtailvideos/templates *
# 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 > 1.4
* [ffmpeg](https://ffmpeg.org/)
## Installing
**This package is not on PyPI yet**
## Using
### On a page model:
Implement as a `ForeinKey` relation, same as wagtailimages.
```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.
```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
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 > 1.4
- `ffmpeg <https://ffmpeg.org/>`__
Installing
----------
**This package is not on PyPI yet**
Using
-----
On a page model:
~~~~~~~~~~~~~~~~
Implement as a ``ForeinKey`` 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
[metadata]
description-file = README.md
description-file = README.rst
......@@ -3,14 +3,14 @@
Install wagtailvideos using setuptools
"""
with open('README.md', 'r') as f:
with open('README.rst', 'r') as f:
readme = f.read()
from setuptools import find_packages, setup
setup(
name='wagtailvideos',
version='0.1.5',
version='0.1.6',
description="A wagtail module for uploading and displaying videos in various codecs.",
long_description=readme,
author='Takeflight',
......
......@@ -5,6 +5,7 @@ from enumchoicefield.forms import EnumField
from wagtail.wagtailadmin import widgets
from wagtail.wagtailadmin.forms import (BaseCollectionMemberForm,
collection_member_permission_formset_factory)
from wagtailvideos.fields import WagtailVideoField
from wagtailvideos.models import MediaFormats, Video
from wagtailvideos.permissions import \
......@@ -51,7 +52,7 @@ def get_video_form(model):
class VideoTranscodeAdminForm(forms.Form):
media_format = EnumField(MediaFormats)
def __init__(self, video, **kwargs, data=None):
def __init__(self, data=None, *, video, **kwargs):
super().__init__(**kwargs, data=None)
self.video = video
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment