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.0a2.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.0a2-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sc_videos-1.0.0a2.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.0a2.tar.gz
Algorithm Hash digest
SHA256 804ee738f805b3e1b4d85a242e610e02f49e89c9dc01602f4dd34d8d9c173d4a
MD5 1dca30abcea56fa489ec818196066744
BLAKE2b-256 9e9a9342042ac2b82da3606e97752c085d0d46b0f01505582211c7ec235c572f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sc_videos-1.0.0a2-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","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.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 2eb9b428afd6dcf57fc2b184a2530ecdbcf365b1470c7cf2be847c7e1c7b40a3
MD5 6ea56e6dfe8c01eb3de93655fa49ef76
BLAKE2b-256 fabb261d6da60f6b6016c5114da9812a0659f16c78fe8f6a89b500d972f10540

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