open_education_network.plugin
=============================

.. py:module:: open_education_network.plugin


Attributes
----------

.. autoapisummary::

   open_education_network.plugin.OEN_LICENSE_TO_SPDX
   open_education_network.plugin.plugin


Classes
-------

.. autoapisummary::

   open_education_network.plugin.OpenEducationNetworkPlugin


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

.. py:data:: OEN_LICENSE_TO_SPDX
   :type:  types.MappingProxyType[str, str]

.. py:class:: OpenEducationNetworkPlugin

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


   Plugin for the Open Education Network (OEN) open textbook library.

   Translates OEN API textbook records into OME EducationResource cards using
   the public JSON API at:
       https://open.umn.edu/opentextbooks/textbooks.json


   .. py:attribute:: mimetypes
      :type:  tuple[str, Ellipsis]
      :value: ('application/vnd.open-education-network.textbook+json',)



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


   .. py:attribute:: site_name
      :type:  str
      :value: 'Open Education Network'



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



   .. py:attribute:: logo
      :type:  str
      :value: 'https://open.umn.edu/assets/oen-logo.png'



   .. py:method:: _spdx_license(abbreviation: str) -> str

      Translate an OEN license abbreviation to an SPDX expression.



   .. py:method:: make_metadata_card(book: server.plugins.open_education_network.open_education_network_models.OENTextbook) -> server.plugins.ome_plugin.EducationResource

      Translate an OENTextbook record into an OME EducationResource.



   .. py:method:: make_metadata_card_from_dict(doc_dict: dict) -> server.plugins.ome_plugin.EducationResource

      Create an EducationResource from a dict of OEN textbook data.



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

      Create an EducationResource from a raw JSON string.



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

      Direct URL lookup is not supported for this plugin.

      Use bulk_import.py to fetch textbooks from the OEN API.



.. py:data:: plugin