mirror of
https://github.com/Hopiu/django-embed-video.git
synced 2026-04-26 23:54:42 +00:00
07de8a3af8
Major changes: - filter ``embed`` is replaced by tag ``video``. - removed caching for whole backend, caching properties instead. - HTTP or HTTPS is set by context.is_secure() (just for ``video`` tag). - backends can be HTTP only (``allow_https = False``). Minor changes: - changed theme of docs to RTD theme. - help about testing HTTPS on development server. - added and modified tests
68 lines
1.6 KiB
ReStructuredText
68 lines
1.6 KiB
ReStructuredText
django-embed-video
|
|
==================
|
|
|
|
Django app for easy embeding YouTube and Vimeo videos and music from SoundCloud.
|
|
|
|
.. image:: https://travis-ci.org/yetty/django-embed-video.png?branch=master
|
|
:target: https://travis-ci.org/yetty/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
|
|
.. image:: https://pypip.in/v/django-embed-video/badge.png
|
|
:target: https://crate.io/packages/django-embed-video/
|
|
.. image:: https://pypip.in/d/django-embed-video/badge.png
|
|
:target: https://crate.io/packages/django-embed-video/
|
|
|
|
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/yetty/django-embed-video.git
|
|
|
|
|
|
#. Add ``embed_video`` to ``INSTALLED_APPS`` in your Django settings.
|
|
|
|
|
|
#. Use 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 }}
|
|
{% endvideo %}
|
|
|
|
Or embed shortcut:
|
|
{% video my_video '800x600' %}
|
|
|
|
#. Use model fields
|
|
|
|
::
|
|
|
|
from django.db import models
|
|
from embed_video.fields import EmbedVideoField
|
|
|
|
class Item(models.Model):
|
|
video = EmbedVideoField() # same like models.URLField()
|
|
|
|
|
|
.. vim: set tw=80:
|