Skip to main content

Open Badge integration for Plone 6.

Project description

eteaching.plone.openbadges

Open Badge integration for Plone 6.

Once the add-on has been installed, the Plone CMS operator can act as the issuing institution. This means they can use a control panel to enter their organisation's data, as well as any necessary prefixes for badge titles. They can then create a new badge in the portal using the new OpenBadges content type. This template provides a title, description, SVG image, award criteria and an associated resource. Additionally, an award period can be specified during which registered Plone members can collect the badge. The badge assertion (the personalised badge) is then automatically generated in the OpenBadge folder. To generate this, a logged-in Plone member must be directed to the badge's URL. This can be done via a link at the end of a successfully completed course, for example. The member will then receive a note detailing the criteria for receiving the badge and will be able to generate it with a single click and switch to the personalised badge view. There, the hosted badge can be verified by entering the email address or using the assertion from external systems. Additionally, badge recipients have the option to share their badge.

Features

  • Provides a way to create Open Badges
  • Provides a way to host Open Badges
  • Provides a way to register an issuing organization
  • Provides a view that allows Open Badges to be viewed, shared, and validated

Prerequisites

  • Plone 6.1 (Classic UI), Plone 6.0 should also work
  • Python 3.10, 3.12, 3.13
  • Git

Install

git clone https://github.com/e-teachingorg/eteaching.plone.openbadges.git
cd eteaching.plone.openbadges
python3 -m venv .
bin/pip3 install uv
make install
make create-site

Start

make start

Install with existing Plone 6.1 buildout

Please note that you need zc.buildout >= 5.1.1. Check requirements.txt

Open your buildout.cfg

[instance]
eggs +=
    eteaching.plone.openbadges

Rerun buildout

bin/buildout

Install as source packages using buildout

Open your dev.cfg

[buildout]
extends = buildout.cfg

parts +=
    instance

auto-checkout +=
    eteaching.plone.openbadges

[sources]
eteaching.plone.openbadges = git https://github.com/e-teachingorg/eteaching.plone.openbadges.git

Rerun buildout

Please note that you need zc.buildout >= 5.1.1. Check requirements.txt

bin/buildout -c dev.cfg
bin/pip3 install -e src/eteaching.plone.openbadges/

Activate

* Start Plone
* Point your browser to your plone site
* Login as admin
* Goto configuration --> extensions
* Install eteaching.plone.openbadges

Authors

Markus Schmidt

Contribute

Support

If you are having issues, please let us know.

License

The project is licensed under the GPLv2.

Funding information

The eteaching.plone.openbadges was funded as part of a publicly financed project by the Federal Ministry of Research, Technology and Space of the Federal Republic of Germany.

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

eteaching_plone_openbadges-1.1.0.tar.gz (34.1 kB view details)

Uploaded Source

Built Distribution

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

eteaching_plone_openbadges-1.1.0-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

Details for the file eteaching_plone_openbadges-1.1.0.tar.gz.

File metadata

File hashes

Hashes for eteaching_plone_openbadges-1.1.0.tar.gz
Algorithm Hash digest
SHA256 fba3e2e4a79ed514ea79719da0d715d0e8a7b317dc57493d31892ba0925366ea
MD5 841d155e6f6c66f82557de4f812ed0f9
BLAKE2b-256 f4037791cb7af4651ea32b1b7a7527a77818f8740dfae541f4bbdad45dac6918

See more details on using hashes here.

File details

Details for the file eteaching_plone_openbadges-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for eteaching_plone_openbadges-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e224d23eebae1be8fa0229949da8b1d8050a975c3f18544043443bdd78ab988
MD5 ee63f2378dbeb962ec35af12b7be8b6d
BLAKE2b-256 73a263b2225973b22242b8e62ab0b770298a27d2b4f0f2311ffe113e792600df

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