https://github.com/suquant/django-vimeo

Django Vimeo
https://github.com/suquant/django-vimeo

Last synced: 9 months ago
JSON representation

Django Vimeo

• Host: GitHub
• URL: https://github.com/suquant/django-vimeo
• Owner: suquant
• License: gpl-2.0
• Created: 2016-01-13T15:07:37.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-07-05T13:51:46.000Z (almost 7 years ago)
• Last Synced: 2025-03-19T00:38:34.554Z (over 1 year ago)
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 4
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
django-vimeo

==================

Django module for easy embedding Vimeo videos into app.

.. image:: https://travis-ci.org/suquant/django-vimeo.svg?branch=master

    :target: https://travis-ci.org/suquant/django-vimeo

.. image:: https://coveralls.io/repos/suquant/django-vimeo/badge.svg?branch=master&service=github

    :target: https://coveralls.io/github/suquant/django-vimeo?branch=master

Quick start

************

#. Install ``django-vimeo``:

   ::

      pip install django-vimeo

   or from sources

   ::

      pip install git+https://github.com/suquant/django-vimeo.git

#. Add ``django_vimeo`` to ``INSTALLED_APPS`` in your Django settings.

#. Add credentials into settings.

   Create new application in https://developer.vimeo.com/apps

   ::

      VIMEO_CLIENT_ID = 'client id'

      VIMEO_CLIENT_SECRET = 'client secret'

      VIMEO_ACCESS_TOKEN = 'access token'

   For activate use cache

   ::

      VIMEO_CACHE_BACKEND = 'default' # Default: None

      VIMEO_CACHE_EXPIRES = 300 # Default: 300 seconds

      "If 'VIMEO_CACHE_BACKEND' not setted or 'None', cache will be not used"

#. Usage of template tags:

   ::

      {% load django_vimeo_tags %}

      The video tag:

      {% vimeo instance.video width=600 as video %}

         

             

             {% trans 'tag "video" not supported by your browser' %}

             {% trans 'download video' %}.

         

      {% endvimeo %}

      Or embed shortcut:

      {% vimeo instance.video width=600 %}

#. Usage of model fields

   ::

      from django.db import models

      from django_vimeo import fields

      class ExampleModel(models.Model):

         video = fields.VimeoField(null=True, blank=True)