Skip to main content

Generate embed (HTML) code of services like Youtube or Vimeo from URLs given. Rules are specified in the plugins.

Project description

Generate embed (HTML) code of services like Youtube or Vimeo from URLs given. Rules are specified in the plugins.

Comes with plugins for the following services (listed in alphabetical order):

  • Vimeo

  • Youtube

Installation

Install with latest stable version from PyPI:

$ pip install vishap

or install the latest stable version from bitbucket:

$ pip install -e hg+https://bitbucket.org/barseghyanartur/vishap@stable#egg=vishap

or install the latest stable version from github:

$ pip install -e git+http://github.org/barseghyanartur/vishap@stable#egg=vishap

That’s all. See the Usage and examples section for more.

Usage and examples

Simple usage

Required imports

from vishap import render_video

Rendering Vimeo code

The following code:

print render_video('http://vimeo.com/45655450', 500, 281)

Would result the following output:

<iframe src="//player.vimeo.com/video/45655450" width="500" height="281"
frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen>
</iframe>

Rendering Youtube code

The following code:

print render_video('http://www.youtube.com/watch?v=LIPl7PtGXNI', 560, 315)

Would result the following output:

<iframe width="560" height="315" src="//www.youtube.com/embed/LIPl7PtGXNI"
frameborder="0" allowfullscreen></iframe>

Filling available area

If you want your embed code to fill the available area, render it without width and height attributes and place it in a container to which it shall stretch.

Example:

s = """<div class="video-wrapper">
{embed_code}
</div>""".format(
    embed_code = render_video('http://www.youtube.com/watch?v=LIPl7PtGXNI')
)

It would then result the following output:

<iframe src="//www.youtube.com/embed/LIPl7PtGXNI"
frameborder="0" allowfullscreen></iframe>

Your CSS file should then look similar to the following

.video-wrapper {
    width: 600px;
    height: 500px;
    padding: 0;
}
    .video-wrapper iframe {
        position: absolute;
        width: 100%;
        height: 100%;
    }

Register a custom plugin

class ExamplePlugin(BaseVideoPlugin):
    uid = "example"
    name = "Example"
    url_pattern = "^(?P<prefix>(http\:\/\/www\.youtube\.com\/watch\?v=)|(http\:\/\/www\.youtube\.com\/v\/)|(http\:\/\/youtu\.be\/))(?P<value>[A-Za-z0-9\-=_]{11})"
    id_pattern = "^(?P<value>[A-Za-z0-9\-=_]{11})"
    thumbnail_pattern = "//img.youtube.com/vi/{0}/{1}.jpg"
    embed_code = """
    <iframe src="//www.youtube.com/embed/{video_id}" {options} frameborder="0" allowfullscreen></iframe>
    """

plugin_registry.register(ExamplePlugin)

Replacing existing plugin

If you want to replace/update existing plugin, you can force register it in the registry.

class UpdatedYoutubePlugin(BaseVideoPlugin):
    uid = "youtube"
    name = "Youtube"
    url_pattern = "^(?P<prefix>(http\:\/\/www\.youtube\.com\/watch\?v=)|(http\:\/\/www\.youtube\.com\/v\/)|(http\:\/\/youtu\.be\/))(?P<value>[A-Za-z0-9\-=_]{11})"
    id_pattern = "^(?P<value>[A-Za-z0-9\-=_]{11})"
    thumbnail_pattern = "//img.youtube.com/vi/{0}/{1}.jpg"
    embed_code = """
    <iframe src="//www.youtube.com/embed/{video_id}" {options} frameborder="0" allowfullscreen></iframe>
    """

plugin_registry.register(UpdatedYoutubePlugin, force=True)

Django integration

Installation

Add vishap.contrib.apps.django.vishap to INSTALLED_APPS

INSTALLED_APPS = (
    # ...
    'vishap.contrib.apps.django.vishap',
    # ...
)

Usage

In your template:

Example #1:

{% load vishap_tags %}
{% render_video 'http://www.youtube.com/watch?v=LIPl7PtGXNI' 560 315 as rendered_video_example_1 %}
{{ rendered_video_example_1|safe }}

Example #2:

{% load vishap_tags %}
{% with video_url='http://vimeo.com/41055612' video_width='500' video_height='281' %}
{% render_video video_url video_width video_height as rendered_video_example_2 %}
{{ rendered_video_example_2|safe }}
{% endwith %}

Missing a plugin?

Missing a plugin for your favourite service? Contribute to the project by making one and it will appear in a new version (which will be released very quickly) or request a feature.

License

GPL 2.0/LGPL 2.1

Support

For any issues contact me at the e-mail given in the Author section.

Author

Artur Barseghyan <artur.barseghyan@gmail.com>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vishap-0.1.4.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

vishap-0.1.4-py2.py3-none-any.whl (19.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file vishap-0.1.4.tar.gz.

File metadata

  • Download URL: vishap-0.1.4.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vishap-0.1.4.tar.gz
Algorithm Hash digest
SHA256 816d76dbfbaf00d27627f5f75ffa10f9c749d90a12cce7ac6784d03feeb73430
MD5 5b7093579fb03454bdcd9a9d61d161b2
BLAKE2b-256 856552c11433cc13ac4218cee35074c8c41bee894c72046d349dc5c446f5b68a

See more details on using hashes here.

File details

Details for the file vishap-0.1.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for vishap-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 17330f12ab26f119780d30fff0046df2ae1f1b3c78d8a5bc49d5e3e120db4516
MD5 0ba540799a3e97a7f7e86f284b1ad419
BLAKE2b-256 14cebc3aeea34f8c35396ff79548afac8072ab57d7ea8575700f4907da04dac3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page