diff --git a/.travis.yml b/.travis.yml index e3a5a0c..ba2ab2b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,9 +1,8 @@ language: python python: - "2.7" + - "3.3" env: - - DJANGO_VERSION=1.4.5 - - DJANGO_VERSION=1.5.1 - DJANGO_VERSION=1.5.2 install: - pip install -q Django==$DJANGO_VERSION --use-mirrors diff --git a/CHANGES.rst b/CHANGES.rst index b32ef96..95d2a8c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,8 +1,5 @@ -Changes -******* - -0.3 ------- +Release 0.3 (Aug. 20, 2013) +---------------------------- - Security fix: faked urls are treated as invalid. See `this page `_ @@ -27,12 +24,12 @@ Changes {% endvideo %} -0.2 ------ +Release 0.2 (June 25, 2013) +---------------------------- - Support of SoundCloud -0.1 ------ +Release 0.1 (June 1, 2013) +---------------------------- - Initial release diff --git a/README.rst b/README.rst index ee81b53..3bdde27 100644 --- a/README.rst +++ b/README.rst @@ -12,115 +12,57 @@ Django app for easy embeding YouTube and Vimeo videos and music from SoundCloud. .. image:: https://pypip.in/d/django-embed-video/badge.png :target: https://crate.io/packages/django-embed-video/ +Documentation +************* -Installation +Documentation is here: http://django-embed-video.rtfd.org/ + + +Quick start ************ -:: +#. Install ``django-embed-video``: - pip install django-embed-video + :: + + pip install django-embed-video -or from sources + or from sources -:: + :: - pip install git+https://github.com/yetty/django-embed-video.git + pip install git+https://github.com/yetty/django-embed-video.git -Add ``embed_video`` to ``INSTALLED_APPS`` in your Django settings. +#. Add ``embed_video`` to ``INSTALLED_APPS`` in your Django settings. -Examples -******** +#. Use template tags: -Template examples ------------------ + :: -First you have to load the `embed_video_tags` template tags in your template: + {% load embed_video_tags %} -:: - - {% load embed_video_tags %} - -Simple embeding of video: - -:: - - {% video item.video as my_video %} - {{ my_video|embed:'small' }} - {% endvideo %} - -Default sizes are ``tiny`` (420x315), ``small`` (480x360), ``medium`` (640x480), -``large`` (960x720) and ``huge`` (1280x960). You can set your own size: - -:: - - {{ my_video|embed:'800x600' }} - -Usage of variables: - -:: - - {% video item.video as my_video %} + The video tag: + {% video item.video as my_video %} URL: {{ my_video.url }} Thumbnail: {{ my_video.thumbnail }} Backend: {{ my_video.backend }} - {% endvideo %} + {% endvideo %} + Or embed shortcut: + {{ my_video|embed:'800x600' }} -There is a simplier way, if you don't need work with parameters as -``my_video.url`` or ``my_video.thumbnail`` and you want to use just ``embed`` -tag. +#. Use model fields -:: + :: - {{ 'http://www.youtube.com/watch?v=guXyvo2FfLs'|embed:'large' }} - - - - -Model examples ---------------- - -Using the EmbedVideoField provides you validation of URLs. - -:: - - from django.db import models - from embed_video.fields import EmbedVideoField - - class Item(models.Model): - video = EmbedVideoField() # same like models.URLField() - - - - -Contributing -************* - -I will be really pleased if you will provide patch to this Django app. Feel free -in changing source code, but please keep `PEP8 `_ -rules and `Zen `_. - - - -TODO -***** - -- provide AdminEmbedVideoMixin -- Vimeo thumbnail - - - -Websites using django-embed-video -********************************* - -- `Tchorici.cz `_ (`sources - `_) - -*Are you using django-embed-video? Send pull request!* + 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: diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..04bc145 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_* diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..7a12fc9 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-embed-video.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-embed-video.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/django-embed-video" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-embed-video" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/api/embed_video.backends.rst b/docs/api/embed_video.backends.rst new file mode 100644 index 0000000..9ce8fad --- /dev/null +++ b/docs/api/embed_video.backends.rst @@ -0,0 +1,5 @@ +Backends +============================================== + +.. automodule:: embed_video.backends + :members: diff --git a/docs/api/embed_video.fields.rst b/docs/api/embed_video.fields.rst new file mode 100644 index 0000000..301dfe7 --- /dev/null +++ b/docs/api/embed_video.fields.rst @@ -0,0 +1,5 @@ +Fields +============================================== + +.. automodule:: embed_video.fields + :members: diff --git a/docs/api/embed_video.template_tags.rst b/docs/api/embed_video.template_tags.rst new file mode 100644 index 0000000..711d924 --- /dev/null +++ b/docs/api/embed_video.template_tags.rst @@ -0,0 +1,13 @@ +Template tags +============================================== + +You have to load template tag library first. + +.. code-block:: html+django + + {% load embed_video_tags %} + + + +.. automodule:: embed_video.templatetags.embed_video_tags + :members: diff --git a/docs/api/index.rst b/docs/api/index.rst new file mode 100644 index 0000000..7da8fb2 --- /dev/null +++ b/docs/api/index.rst @@ -0,0 +1,8 @@ +API reference +============================================== + + +.. toctree:: + :glob: + + embed_video.* diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..9a94e50 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,263 @@ +# -*- coding: utf-8 -*- +# +# django-embed-video documentation build configuration file, created by +# sphinx-quickstart on Thu Aug 22 08:38:40 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('..')) + +os.environ['DJANGO_SETTINGS_MODULE'] = 'embed_video.tests.django_settings' + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'django-embed-video' +copyright = u'2013, Juda Kaleta' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.3' +# The full version, including alpha/beta/rc tags. +release = '0.3' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +todo_include_todos = True + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'django-embed-videodoc' + + + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'django-embed-video.tex', u'django-embed-video Documentation', + u'Juda Kaleta', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'django-embed-video', u'django-embed-video Documentation', + [u'Juda Kaleta'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'django-embed-video', u'django-embed-video Documentation', + u'Juda Kaleta', 'django-embed-video', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'python': ('http://docs.python.org/2.7', None), + 'django': ('https://docs.djangoproject.com/en/1.5/', + 'http://docs.djangoproject.com/en/1.5/_objects/'), +} diff --git a/docs/development/changelog.rst b/docs/development/changelog.rst new file mode 100644 index 0000000..89c36e8 --- /dev/null +++ b/docs/development/changelog.rst @@ -0,0 +1,4 @@ +Changelog +============================================== + +.. include:: ../../CHANGES.rst diff --git a/docs/development/contributing.rst b/docs/development/contributing.rst new file mode 100644 index 0000000..aedc0a3 --- /dev/null +++ b/docs/development/contributing.rst @@ -0,0 +1,13 @@ +Contributing +============================================== + +I will be really pleased if you will provide patch to this Django app. Feel free +in changing source code, but please keep `PEP8 `_ +rules and `Zen `_. + +It is a good habit to cover your patches with :doc:`tests `. + +Our repository is placed on this URL: +https://github.com/yetty/django-embed-video + + diff --git a/docs/development/index.rst b/docs/development/index.rst new file mode 100644 index 0000000..08bda9b --- /dev/null +++ b/docs/development/index.rst @@ -0,0 +1,11 @@ +Development +============================================== + + +.. toctree:: + :glob: + + contributing + testing + changelog + todos diff --git a/docs/development/testing.rst b/docs/development/testing.rst new file mode 100644 index 0000000..5bffcbb --- /dev/null +++ b/docs/development/testing.rst @@ -0,0 +1,19 @@ +Testing +============================================== + +Run tests with this command: + +:: + + python setup.py test + + +Be sure to run it before each commit and fix broken tests. + + +Run tests with coverage: + +:: + + coverage run --source=embed_video setup.py test + coverage report diff --git a/docs/development/todos.rst b/docs/development/todos.rst new file mode 100644 index 0000000..8716b24 --- /dev/null +++ b/docs/development/todos.rst @@ -0,0 +1,9 @@ +TODOs list +============================================== + +- provide AdminEmbedVideoMixin +- Vimeo thumbnail + +.. todolist:: + + diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..1fd75b5 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,90 @@ +Examples +============================================== + +Template examples +############################################## + +.. highlight:: html+django + +First you have to load the `embed_video_tags` template tags in your template: + +:: + + {% load embed_video_tags %} + +Simple embeding of video: + +:: + + {% video item.video as my_video %} + {{ my_video|embed:'small' }} + {% endvideo %} + +Default sizes are ``tiny`` (420x315), ``small`` (480x360), ``medium`` (640x480), +``large`` (960x720) and ``huge`` (1280x960). You can set your own size: + +:: + + {{ my_video|embed:'800x600' }} + +Usage of variables: + +:: + + {% video item.video as my_video %} + URL: {{ my_video.url }} + Thumbnail: {{ my_video.thumbnail }} + Backend: {{ my_video.backend }} + {% endvideo %} + + +There is a simplier way, if you don't need work with parameters as +``my_video.url`` or ``my_video.thumbnail`` and you want to use just ``embed`` +tag. + +:: + + {{ 'http://www.youtube.com/watch?v=guXyvo2FfLs'|embed:'large' }} + + + + +Model examples +############################################### + +.. highlight:: python + +Using the EmbedVideoField provides you validation of URLs. + +:: + + from django.db import models + from embed_video.fields import EmbedVideoField + + class Item(models.Model): + video = EmbedVideoField() # same like models.URLField() + + + +Admin examples +############################################### + +.. todo:: + + Admin mixins are on TODO list. Be patient or send :doc:`pull request + ` :). + + + +Low level API examples +############################################### + +You can get instance of :py:class:`~embed_video.backends.VideoBackend` in your +python code thanks to :py:func:`~embed_video.backends.detect_backend`: + +:: + + from embed_video.backends import detect_backend + + my_video = detect_backend('http://www.youtube.com/watch?v=H4tAOexHdR4') + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..bbb9a7f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +django-embed-video's documentation +============================================== + +Django app for easy embeding YouTube and Vimeo videos and music from SoundCloud. + +Repository is located on GitHub: https://github.com/yetty/django-embed-video + + +.. 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/ + + + +.. toctree:: + :maxdepth: 2 + :glob: + + installation + examples + + development/index + + websites + + + +API +################# + +.. toctree:: + api/index + + + +Indices and tables +################################################# + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..78f5050 --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,34 @@ +Installation & Setup +============================================== + +Installation +############################################## + +Use pip to install package: + +:: + + pip install django-embed-video + + +If you want latest version, you may use Git. It is fresh, but unstable. + +:: + + pip install git+https://github.com/yetty/django-embed-video.git + + +Setup +############################################## + +Add ``embed_video`` to :py:data:`~django.settings.INSTALLED_APPS` in your Django +settings. + +:: + + INSTALLED_APPS = ( + ... + + 'embed_video', + ) + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..c7eafb3 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-embed-video.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-embed-video.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/docs/websites.rst b/docs/websites.rst new file mode 100644 index 0000000..5bbbd33 --- /dev/null +++ b/docs/websites.rst @@ -0,0 +1,10 @@ +Websites using django-embed-video +============================================== + +- `Tchorici.cz `_ (`sources + `_) + +*Are you using django-embed-video? Send pull request!* + + + diff --git a/embed_video/base.py b/embed_video/backends.py similarity index 76% rename from embed_video/base.py rename to embed_video/backends.py index 57ecc42..d52cc35 100644 --- a/embed_video/base.py +++ b/embed_video/backends.py @@ -23,7 +23,11 @@ class UnknownIdException(Exception): def detect_backend(url): - if DETECT_YOUTUBE.search(url): + """ + Detect the right backend for given URL. + """ + + if DETECT_YOUTUBE.match(url): return YoutubeBackend(url) elif DETECT_VIMEO.match(url): return VimeoBackend(url) @@ -34,6 +38,31 @@ def detect_backend(url): class VideoBackend(object): + """ + Base backend, good to inherit. + """ + + re_code = None + """ + Compiled regex (:py:func:`re.compile`) to search code in URL. + + Example: ``re.compile(r'myvideo\.com/\?code=(?P\w+)')`` + """ + + pattern_url = None + """ + Pattern in which the code is inserted. + + Example: ``http://myvideo.com?code=%s`` + """ + + pattern_thumbnail_url = None + """ + Pattern in which the code is inserted to get thumbnail url. + + Example: ``http://static.myvideo.com/thumbs/%s`` + """ + def __init__(self, url): self._url = url @@ -43,11 +72,17 @@ class VideoBackend(object): self.thumbnail = self.get_thumbnail_url() def get_code(self): + """ + Returns searched code from URL by :py:data:`re_code`. + """ match = self.re_code.search(self._url) if match: return match.group('code') def get_url(self): + """ + Returns URL folded from :py:data:`pattern_url` and parsed code. + """ return self.pattern_url % self.code def get_thumbnail_url(self): @@ -55,6 +90,9 @@ class VideoBackend(object): class YoutubeBackend(VideoBackend): + """ + Backend for YouTube URLs. + """ re_code = re.compile( # r'youtu(?:be\.com/watch\?v=|\.be/)(?P[\w-]*)(&(amp;)?[\w\?=]*)?', r'''youtu(\.?)be(\.com)?/ # match youtube's domains @@ -83,8 +121,11 @@ class YoutubeBackend(VideoBackend): class VimeoBackend(VideoBackend): - re_code = re.compile( - r'''vimeo\.com/(video/)?(?P[0-9]+)''', re.I) + """ + Backend for Vimeo URLs. + """ + + re_code = re.compile(r'''vimeo\.com/(video/)?(?P[0-9]+)''', re.I) pattern_url = 'http://player.vimeo.com/video/%s' def get_thumbnail_url(self): @@ -92,6 +133,9 @@ class VimeoBackend(VideoBackend): class SoundCloudBackend(VideoBackend): + """ + Backend for SoundCloud URLs. + """ base_url = 'http://soundcloud.com/oembed' re_code = re.compile(r'src=".*%2F(?P\d+)&show_artwork.*"', re.I) diff --git a/embed_video/fields.py b/embed_video/fields.py index 47508c3..54e6578 100644 --- a/embed_video/fields.py +++ b/embed_video/fields.py @@ -2,12 +2,19 @@ from django.db import models from django import forms from django.utils.translation import ugettext_lazy as _ -from .base import detect_backend, UnknownIdException, UnknownBackendException +from .backends import detect_backend, UnknownIdException, \ + UnknownBackendException __all__ = ('EmbedVideoField', 'EmbedVideoFormField') class EmbedVideoField(models.URLField): + """ + + Model field for embeded video. Descendant of + :py:class:`django.db.models.URLField`. + """ + def formfield(self, **kwargs): defaults = {'form_class': EmbedVideoFormField} defaults.update(kwargs) @@ -24,6 +31,12 @@ class EmbedVideoField(models.URLField): class EmbedVideoFormField(forms.URLField): + """ + + Form field for embeded video. Descendant of + :py:class:`django.forms.URLField` + """ + def validate(self, url): super(EmbedVideoFormField, self).validate(url) diff --git a/embed_video/templatetags/embed_video_tags.py b/embed_video/templatetags/embed_video_tags.py index 4772a25..ba7537b 100644 --- a/embed_video/templatetags/embed_video_tags.py +++ b/embed_video/templatetags/embed_video_tags.py @@ -1,13 +1,36 @@ from django.template import Library, Node, TemplateSyntaxError from django.utils.safestring import mark_safe, SafeText -from ..base import detect_backend, SoundCloudBackend +from ..backends import detect_backend, SoundCloudBackend register = Library() @register.tag('video') class VideoNode(Node): + """ + Template tag ``video``. It gives access to all + :py:class:`~embed_video.backends.VideoBackend` variables. + + Usage: + + .. code-block:: html+django + + {% video URL as VAR %} + ... + {% endvideo %} + + Example: + + .. code-block:: html+django + + {% video item.video as my_video %} + URL: {{ my_video.url }} + Thumbnail: {{ my_video.thumbnail }} + Backend: {{ my_video.backend }} + {% endvideo %} + + """ error_msg = ('Syntax error. Expected: ``video source as var``') def __init__(self, parser, token): @@ -39,12 +62,44 @@ class VideoNode(Node): @register.filter(is_safe=True) -def embed(backend, _size='small'): +def embed(backend, size='small'): + """ + Shortcut for :py:func:`VideoNode` tag. + + Usage: + + .. code-block:: html+django + + {{ URL|embed:SIZE }} + + Example: + + .. code-block:: html+django + + {{ 'http://www.youtube.com/watch?v=guXyvo2FfLs'|embed:'large' }} + + Predefined sizes: + + ======== ======== ========= + size width height + ======== ======== ========= + tiny 420 315 + small 480 360 + medium 640 480 + large 960 720 + huge 1280 960 + ======== ======== ========= + + You can also use custom size - in format ``WIDTHxHEIGHT`` + (eg. ``500x400``). + + """ + if isinstance(backend, SafeText): backend = detect_backend(backend) - size = _embed_get_size(_size) - params = _embed_get_params(backend, size) + _size = _embed_get_size(size) + params = _embed_get_params(backend, _size) return mark_safe( '