oercommons.plugin
=================

.. py:module:: oercommons.plugin


Attributes
----------

.. autoapisummary::

   oercommons.plugin.json_path


Classes
-------

.. autoapisummary::

   oercommons.plugin.OERCommonsPlugin


Module Contents
---------------

.. py:class:: OERCommonsPlugin

   Bases: :py:obj:`server.plugins.ome_plugin.OMEPlugin`


   This class represents the OERCommons plugin, which is a subclass of OMEPlugin.
   It provides functionality to create metadata cards from URLs or JSON payloads.


   .. py:attribute:: mimetypes
      :type:  tuple[str]
      :value: ('application/vnd.oercommons.oer-commons+json',)



   .. py:attribute:: newsgroups
      :type:  dict[str, str]


   .. py:attribute:: site_name
      :type:  str
      :value: 'OERCommons'



   .. py:attribute:: librarian_contact
      :type:  str
      :value: 'info@iskme.org'



   .. py:attribute:: logo
      :type:  str
      :value: 'https://oercommons.org/static/newdesign/images/header/oerc-logo.png'



   .. py:method:: make_metadata_card_from_url(url: str) -> server.plugins.ome_plugin.EducationResource

      This method creates a metadata card from a given URL.
      It currently does not implement any functionality.



   .. py:method:: make_metadata_card_from_json(json_payload: str) -> server.plugins.ome_plugin.EducationResource

      This method creates a metadata card from a given JSON payload.
      It currently does not implement any functionality.



.. py:data:: json_path