oapen_books.plugin
==================

.. py:module:: oapen_books.plugin


Attributes
----------

.. autoapisummary::

   oapen_books.plugin.plugin


Classes
-------

.. autoapisummary::

   oapen_books.plugin.OapenBooksPlugin


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

.. py:class:: OapenBooksPlugin

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


   Plugin for the OAPEN Library (https://library.oapen.org).

   The OAPEN (Open Access Publishing in European Networks) Library hosts
   peer-reviewed open access books and book chapters, primarily from European
   academic publishers.  This plugin uses the public OAPEN DSpace REST API
   to translate book metadata into OME EducationResource cards.

   API docs: https://library.oapen.org/rest/


   .. py:attribute:: mimetypes
      :type:  tuple[str, Ellipsis]
      :value: ('application/vnd.oapen.book+json',)



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


   .. py:attribute:: site_name
      :type:  str
      :value: 'OAPEN Library'



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



   .. py:attribute:: logo
      :type:  str
      :value: 'https://oapen.org/img/oapen-logo.jpg'



   .. py:method:: make_metadata_card(item: server.plugins.oapen_books.oapen_models.OapenItem) -> server.plugins.ome_plugin.EducationResource

      Translate an OapenItem 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 OAPEN item 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

      Create a metadata card from a book URL.

      Direct URL lookup is not currently supported.
      Use bulk_import.py to fetch books from the OAPEN REST API.



.. py:data:: plugin