openstax.plugin¶

Attributes¶

Classes¶

OpenStaxPlugin

Plugin to translate OpenStax book metadata to OME EducationResource cards.

Module Contents¶

class openstax.plugin.OpenStaxPlugin¶

Bases: server.plugins.ome_plugin.OMEPlugin

Plugin to translate OpenStax book metadata to OME EducationResource cards.

mimetypes: tuple[str, Ellipsis] = ('application/vnd.openstax.book+json',)¶

newsgroups: dict[str, str]¶

site_name: str = 'OpenStax'¶

librarian_contact: str = 'info@iskme.org'¶

logo: str = 'https://openstax.org/dist/images/logos/logo.svg'¶

make_metadata_card(book: server.plugins.openstax.openstax_models.OpenStaxBook) → server.plugins.ome_plugin.EducationResource¶

make_metadata_card_from_dict(doc_dict: dict) → server.plugins.ome_plugin.EducationResource¶: Create metadata card from a dict of OpenStax book data.

make_metadata_card_from_json(json_payload: str) → server.plugins.ome_plugin.EducationResource¶: Create metadata card from a JSON payload.

make_metadata_card_from_url(url: str) → server.plugins.ome_plugin.EducationResource¶: Create metadata card from a URL.

openstax.plugin.json_path¶