mirror of
https://github.com/Hopiu/django-embed-video.git
synced 2026-03-16 21:30:23 +00:00
83 lines
1.9 KiB
ReStructuredText
83 lines
1.9 KiB
ReStructuredText
django-embed-video
|
|
==================
|
|
|
|
Django app for easy embedding YouTube and Vimeo videos and music from SoundCloud.
|
|
|
|
.. image:: https://jazzband.co/static/img/badge.svg
|
|
:target: https://jazzband.co/
|
|
:alt: Jazzband
|
|
.. image:: https://travis-ci.org/jazzband/django-embed-video.png?branch=master
|
|
:target: https://travis-ci.org/jazzband/django-embed-video
|
|
.. image:: https://coveralls.io/repos/yetty/django-embed-video/badge.png?branch=master
|
|
:target: https://coveralls.io/r/yetty/django-embed-video?branch=master
|
|
|
|
Documentation
|
|
*************
|
|
|
|
Documentation is here: http://django-embed-video.rtfd.org/
|
|
|
|
|
|
Quick start
|
|
************
|
|
|
|
#. Install ``django-embed-video``:
|
|
|
|
::
|
|
|
|
pip install django-embed-video
|
|
|
|
|
|
or from sources
|
|
|
|
::
|
|
|
|
pip install git+https://github.com/jazzband/django-embed-video
|
|
|
|
|
|
#. Add ``embed_video`` to ``INSTALLED_APPS`` in your Django settings.
|
|
|
|
#. If you want to detect HTTP/S in template tags, you have to set ``request``
|
|
context processor in ``settings.TEMPLATES``:
|
|
|
|
::
|
|
|
|
TEMPLATES = [
|
|
{
|
|
'BACKEND': 'django.template.backends.django.DjangoTemplates',
|
|
# ...
|
|
'OPTIONS': {
|
|
'context_processors': [
|
|
# ...
|
|
'django.template.context_processors.request',
|
|
],
|
|
},
|
|
},
|
|
]
|
|
|
|
#. Usage of template tags:
|
|
|
|
::
|
|
|
|
{% load embed_video_tags %}
|
|
|
|
The video tag:
|
|
{% video item.video as my_video %}
|
|
URL: {{ my_video.url }}
|
|
Thumbnail: {{ my_video.thumbnail }}
|
|
Backend: {{ my_video.backend }}
|
|
|
|
{% video my_video "large" %}
|
|
{% endvideo %}
|
|
|
|
Or embed shortcut:
|
|
{% video my_video '800x600' %}
|
|
|
|
#. Usage of model fields
|
|
|
|
::
|
|
|
|
from django.db import models
|
|
from embed_video.fields import EmbedVideoField
|
|
|
|
class Item(models.Model):
|
|
video = EmbedVideoField() # same like models.URLField()
|