Skip to main content

Social media components for Plone and Volto

Project description

plonegovbr.socialmedia

Social media components for Plone and Volto

PyPI PyPI - Python Version PyPI - Wheel PyPI - License PyPI - Status PyPI - Plone Versions

CI GitHub contributors GitHub Repo stars

Overview 📚

plonegovbr.socialmedia provides behaviors for managing social media metadata and links in Plone sites. It can be used both with the Volto frontend.

Features ✨

This package provides two Dexterity behaviors:

plonegovbr.socialmedia.settings

Designed for navigation root objects (e.g., the Plone Site itself), it replaces the classic Social Media control panel, providing:

  • share_social_data: Enable/disable sharing social metadata for content.
  • facebook_app_id: Populate the fb:app_id meta tag.
  • social_links: List of social media profile URLs.
  • facebook_username: Auto-calculated to populate og:article:publisher.
  • x_username: Auto-calculated to populate twitter:site.

plonegovbr.socialmedia.links

Designed for content types that require listing social network profiles (e.g., Speaker Profiles on a conference site).

  • social_links: List of social media profile URLs.

Installation 🛠️

Add plonegovbr.socialmedia to your project dependencies.

Using setup.py 🐍

In your setup.py:

install_requires = [
    ...
    "plonegovbr.socialmedia",
]

Then install:

pip install -e .

Using pyproject.toml 📜

In your pyproject.toml:

dependencies = [
    ...
    "plonegovbr.socialmedia",
]

Then install:

pip install .

Usage 📖

After installation:

  1. Go to the Plone Control Panel and enable the plonegovbr.socialmedia.settings behavior for your Plone Site.
  2. Edit the root object to configure social media settings.

To use the plonegovbr.socialmedia.links behavior on other content types:

  1. Go to Control Panel → Content Types.
  2. Select the content type (e.g., Event).
  3. In the Behaviors tab, enable Social Media: Links.
  4. Save the changes.

Volto Support ⚡

For Volto frontend integration, install @plonegovbr/social-media in your Volto project.

This package provides Volto widgets that integrate seamlessly with the fields provided by plonegovbr.socialmedia.

pnpm add @plonegovbr/social-media
# or
npm install @plonegovbr/social-media

Compatibility ✅

  • Plone: 6.1+
  • Python: 3.10+
  • Volto: 18+

Contributing 🤝

Contributions are welcome!

Before submitting a pull request, please make sure your code passes tests and follows project guidelines.

License 📜

This project is licensed under the GPLv2.

Credits & Acknowledgements 🙏

Maintained by the PloneGov-Br Community 🇧🇷❤️.

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

plonegovbr_socialmedia-2.0.0a2.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

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

plonegovbr_socialmedia-2.0.0a2-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

Details for the file plonegovbr_socialmedia-2.0.0a2.tar.gz.

File metadata

File hashes

Hashes for plonegovbr_socialmedia-2.0.0a2.tar.gz
Algorithm Hash digest
SHA256 7e397361f99c9c302bd2a7696493e13213790238e344b0898ab20f482f875140
MD5 1a98571698e06051b628c6d71a81dadf
BLAKE2b-256 9a1845b7d20abe0eca6005d661d83e067f0404332c313aaa279937c9e522950a

See more details on using hashes here.

File details

Details for the file plonegovbr_socialmedia-2.0.0a2-py3-none-any.whl.

File metadata

File hashes

Hashes for plonegovbr_socialmedia-2.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 c1068df8c6eb43fe266aa5090cec7ebc0e072ae51fc5c249fa1ac01916fee0e2
MD5 623f5e6ae0b74f1c4ce4c370db08a9e8
BLAKE2b-256 b1cdff5966ee141516748854a81d1ce8dabdf2dae5abd7494856444652e7dafc

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