Skip to main content

README

rstyoutube is a package for embedding youtube videos in reStructuredText documents.

The code lives at http://bitbucket.org/cliff/rstyoutube. Bug reports, feature requests, and contributions are all welcome. If you find the code useful, hop on bitbucket and send me a quick message letting me know.

Usage

To use with pelican or another docutils-based system, add the following to your pelican configuration file:

import rstyoutube
rstyoutube.setup_docutils()

To use rstyoutube in standalone rst files, you can use the included rst2html+youtube.py script, which should get installed onto your PATH.

In your reST document, include a youtube directive with the video’s id as the sole argument as follows:

This is my document

.. youtube:: 5blbv4WFriM

Hope you enjoyed the video.

That’s all it takes.

Options

If you want more fine-grained control, you can add various options:

.. youtube:: 5blbv4WFriM
    :start: 67
    :width: 640
    :height: 480
    :ssl:
    :hd:

start

The number of seconds into the video where you want to start playback.

width

height

The size of the embedded viewer. Defaults to 640x480, or if the hd option is set, defaults to 1080x720.

ssl

This option takes no arguments. If it is present, the player is embedded over https, rather than http.

hd

This option takes no arguments. If it is present, the embedded video is shown in HD. The player’s default size becomes 1080x720, but can still be overridden using the width and height options.

Changelog

0.1.1 – 2011/12/15

Added options

0.1.0 – 2011/12/15

Initial release

To Do

  • Add options to allow people to customize their videos.

Metadata

Release files for rstyoutube 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rstyoutube 0.1.1
File Size Uploaded Provenance Actions
rstyoutube-0.1.1.tar.gz 3.7 kB Without provenance Details for rstyoutube-0.1.1.tar.gz

Release files / rstyoutube-0.1.1.tar.gz

Download URL rstyoutube-0.1.1.tar.gz
Size 3.7 kB
Tags Source
SHA-256 checksum
How to use checksums
c7d4cb761680be01c0f5630805db87c01125c89cf6209784ac23806910f90ecd
BLAKE2b-256 checksum
How to use checksums
4a7d44cc3b1d819d2dd702e386f7a54c08ccf7058411f7e8120e1d719d8a12ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for rstyoutube 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page