Hopiu/django-embed-video
1
0
Fork 0
mirror of https://github.com/Hopiu/django-embed-video.git synced 2026-04-19 20:50:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Django app for easy embedding YouTube and Vimeo videos and music from SoundCloud.
194 commits 2 branches 13 tags 368 KiB
Python 96.9%
HTML 3.1%
Find a file
Brad Buran 5ebea38220 Updated video template tag to accept kwargs 
Some video backends support optional arguments embedded in the URL query
string that adjust how the video is displayed (e.g. Youtube supports
rel=0 which means don't show related videos).  Updated the template tag
to accept optional KEY=VALUE pairs that will be added onto the embedded
URL as a query string.  Also added support for specifying default query
strings on a per-backend basis (e.g. so that all YouTube urls have
?rel=0 added to the end).

Added appropriate tests and documentation.
2014-05-01 07:17:53 -04:00
docs Updated video template tag to accept kwargs 2014-05-01 07:17:53 -04:00
embed_video Updated video template tag to accept kwargs 2014-05-01 07:17:53 -04:00
example_project Minor codestyle improvements 2014-02-22 10:22:58 +01:00
.coveragerc Omit redundant files in coverage 2013-08-22 14:59:06 +02:00
.gitignore Ignore output of coverage html 2013-07-31 10:14:57 +02:00
.travis.yml python setup.py test 2014-04-04 19:51:15 +02:00
CHANGES.rst Complete change log + prepare for 0.10 2014-04-04 20:26:33 +02:00
LICENSE License 2013-05-31 13:25:11 +02:00
MANIFEST.in Fixes #22. Include html templates. 2014-03-25 22:11:57 +01:00
README.rst Fix spelling mistake in README 2014-01-07 10:05:38 +01:00
setup.py python setup.py test 2014-04-04 19:51:15 +02:00

README.rst 

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.

#. If you want to detect HTTP/S in template tags, you have to set ``request``
   context processor in ``settings.TEMPLATE_CONTEXT_PROCESSORS``:

   ::

       TEMPLATE_CONTEXT_PROCESSORS = (
           ...
           'django.core.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()


.. vim: set tw=80: