Metadata-Version: 2.4
Name: eteaching.plone.openbadges
Version: 1.0.4
Summary: Open Badge integration for Plone.
Home-page: https://github.com/collective/eteaching.plone.openbadges
Author: Markus Schmidt
Author-email: m.schmidt@iwm-tuebingen.de
License: GPL version 2
Project-URL: Homepage, https://github.com/e-teachingorg/eteaching.plone.openbadges
Project-URL: Source, https://github.com/e-teachingorg/eteaching.plone.openbadges
Project-URL: Tracker, https://github.com/e-teachingorg/eteaching.plone.openbadges/issues
Project-URL: Documentation, https://github.com/e-teachingorg/eteaching.plone.openbadges
Project-URL: ChangeLog, https://github.com/e-teachingorg/eteaching.plone.openbadges/blob/main/CHANGELOG.md
Keywords: Python Plone CMS
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 6.1
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: >=3.10
License-File: LICENSE.GPL
License-File: LICENSE.rst
Requires-Dist: setuptools
Requires-Dist: z3c.jbot
Requires-Dist: plone.api>=1.8.4
Requires-Dist: plone.app.dexterity
Requires-Dist: plone.app.event
Provides-Extra: test
Requires-Dist: plone.app.testing; extra == "test"
Requires-Dist: plone.testing>=5.0.0; extra == "test"
Requires-Dist: plone.app.contenttypes; extra == "test"
Requires-Dist: plone.app.robotframework[debug]; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

eteaching.plone.openbadges
==========================

Open Badge integration for `Plone 6 <https://plone.org/>`__.

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 with Plone 6.1 buildout
-------------------------------

.. code:: bash

   git clone https://github.com/e-teachingorg/eteaching.plone.openbadges.git
   cd eteaching.plone.openbadges
   python3 -m venv .
   bin/pip install -r https://dist.plone.org/release/6.1-latest/requirements.txt
   bin/buildout

Activate
~~~~~~~~

.. code:: bash

   bin/instance fg

-  Point your browser to http://localhost:8080
-  Add a new Plone Site (Classic UI)
-  Login with admin admin
-  Goto admin –> configuration –> extensions
-  eteaching.plone.openbadges [Install]

Install as source packages using buildout
-----------------------------------------

Open your dev.cfg

.. code:: bash

   [buildout]
   extends = buildout.cfg

   parts +=
       instance

   auto-checkout +=
       eteaching.plone.openbadges

   [instance]
   eggs +=
       eteaching.plone.openbadges

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

Rerun buildout
~~~~~~~~~~~~~~

.. code:: bash

   bin/buildout -c dev.cfg

.. _activate-1:

Activate
~~~~~~~~

.. code:: bash

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

Authors
-------

`Markus Schmidt <https://github.com/Arkusm>`__

Contribute
----------

-  Issue Tracker:
   https://github.com/e-teachingorg/eteaching.plone.openbadges/issues
-  Source Code:
   https://github.com/e-teachingorg/eteaching.plone.openbadges

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.
