Skip to main content

A Plone add-on providing a Video content type that supports external video sources

Project description

🎬 sc.videos

PyPI CI

sc.videos is the backend Python package for the sc-videos Plone add-on. It provides a Video content type with automatic metadata fetching from YouTube and Vimeo.

This package requires the frontend companion add-on @simplesconsultoria/volto-videos to be installed in your Volto frontend. Both packages are developed and released together from the sc-videos monorepo.

✨ Features

  • 📄 Video content type — a Dexterity container with the IRemoteVideo behavior for external video URLs, automatic metadata population, and preview image downloads.
  • 🔌 Extensible provider system — YouTube (Data API v3 + public oEmbed fallback) and Vimeo out of the box. Add new providers by registering a named IVideoMetadataProvider utility.
  • 🌐 @video-metadata REST API — POST a video URL, receive structured metadata (title, description, duration, thumbnail, channel, tags).
  • ⚙️ Video Settings control panel — configure the YouTube API key and toggle between API and oEmbed modes.
  • 📇 Catalog metadatavideoUrl is exposed as a catalog column for efficient search result rendering.
  • 🔐 Custom field validation — the VideoURL field validates URLs against registered providers at the schema level.

📦 Installation

Add sc.videos to your project's backend policy package's pyproject.toml:

[project]
dependencies = [
    "Products.CMFPlone",
    "sc.videos",
]

Load the ZCML configuration in your package's dependencies.zcml or configure.zcml:

<include package="sc.videos" />

Then install:

make install

After starting the site, activate Video Support for Plone in Site Setup → Add-ons.

📚 Documentation

Full documentation (tutorials, how-to guides, concepts, and reference) is available at:

simplesconsultoria.github.io/sc-videos

🤝 Contribute

For development setup and contribution guidelines, see the monorepo README and the contribution guide.

📜 License

GPLv2

🙏 Credits

The development of this add-on was supported by:

Generated using Cookieplone (2.0.0a1) and cookieplone-templates (c0e9ef0) on 2026-04-10 16:04:11.973530. A special thanks to all contributors and supporters!

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

sc_videos-1.0.0a1.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sc_videos-1.0.0a1-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file sc_videos-1.0.0a1.tar.gz.

File metadata

  • Download URL: sc_videos-1.0.0a1.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for sc_videos-1.0.0a1.tar.gz
Algorithm Hash digest
SHA256 4ddb6893a03334d9c25481548ff19be3c3137b1b11fa12d418c33c94021b46af
MD5 83b2c09b69c8ddc427149029a4b4a950
BLAKE2b-256 ee90d63ac50ee88a8ebd9bbe5b50d1aae5987d93d3850481948c7b0313ec088e

See more details on using hashes here.

File details

Details for the file sc_videos-1.0.0a1-py3-none-any.whl.

File metadata

  • Download URL: sc_videos-1.0.0a1-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for sc_videos-1.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 6a97abde7787d8d10bd4bfa71ada75a7a9c5d01feca0cb97fe6ab9c43f9f5d65
MD5 cb55bfa90119c44b7d02c4c7b47156ec
BLAKE2b-256 6e230a11002d651083e653351f0275d282b08b9375ab378b2f981a6974d4fd80

See more details on using hashes here.

Supported by

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