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.0a4.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.0a4-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for plonegovbr_socialmedia-2.0.0a4.tar.gz
Algorithm Hash digest
SHA256 754a3501129c200a5519bd3df5f8990810e3be6b7a8cf3aa12513a529abe094e
MD5 dcd7c1163116922de158306bcfabf02f
BLAKE2b-256 31d817e8a1a672c17af0b998fcb9e67e55edc69b777bc12003a588ca8deaa327

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for plonegovbr_socialmedia-2.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 a53495002f297847588c6b398612f29e09791082f66be247e41cc5ea0670be2d
MD5 48e8f80d33c0ec4cc8b50abf0e47fe8b
BLAKE2b-256 7ce67110c80c35cfae0986c3eee2f3b1311a60359dbab6eb375566c54545fe96

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