open_education_network.open_education_network_models
====================================================

.. py:module:: open_education_network.open_education_network_models


Attributes
----------

.. autoapisummary::

   open_education_network.open_education_network_models.here


Classes
-------

.. autoapisummary::

   open_education_network.open_education_network_models.OENLicense
   open_education_network.open_education_network_models.OENChildSubject
   open_education_network.open_education_network_models.OENSubject
   open_education_network.open_education_network_models.OENContributor
   open_education_network.open_education_network_models.OENFormat
   open_education_network.open_education_network_models.OENTextbook
   open_education_network.open_education_network_models.OENTextbookList


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

.. py:class:: OENLicense(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   License information for an Open Education Network textbook.


   .. py:attribute:: name
      :type:  str
      :value: None



   .. py:attribute:: abbreviation
      :type:  str
      :value: None



   .. py:attribute:: url
      :type:  str
      :value: None



.. py:class:: OENChildSubject(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A child subject for an Open Education Network textbook.


   .. py:attribute:: name
      :type:  str
      :value: None



.. py:class:: OENSubject(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A subject entry for an Open Education Network textbook.


   .. py:attribute:: name
      :type:  str
      :value: None



   .. py:attribute:: child_subject
      :type:  OENChildSubject
      :value: None



.. py:class:: OENContributor(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A contributor (author, editor, etc.) for an Open Education Network textbook.


   .. py:attribute:: first_name
      :type:  str
      :value: None



   .. py:attribute:: last_name
      :type:  str
      :value: None



   .. py:attribute:: contribution_type
      :type:  str
      :value: None



   .. py:property:: full_name
      :type: str


      Return the contributor's full name.



.. py:class:: OENFormat(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A format (eBook, PDF, etc.) for an Open Education Network textbook.


   .. py:attribute:: format
      :type:  str
      :value: None



   .. py:attribute:: url
      :type:  str
      :value: None



.. py:class:: OENTextbook(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   A single textbook record as returned by the Open Education Network API.

   Endpoint: GET https://open.umn.edu/opentextbooks/textbooks.json


   .. py:attribute:: id
      :type:  int
      :value: None



   .. py:attribute:: title
      :type:  str
      :value: None



   .. py:attribute:: description
      :type:  str
      :value: None



   .. py:attribute:: url
      :type:  str
      :value: None



   .. py:attribute:: cover_url
      :type:  str
      :value: None



   .. py:attribute:: license
      :type:  OENLicense
      :value: None



   .. py:attribute:: subjects
      :type:  list[OENSubject]
      :value: None



   .. py:attribute:: contributors
      :type:  list[OENContributor]
      :value: None



   .. py:attribute:: formats
      :type:  list[OENFormat]
      :value: None



   .. py:property:: authors
      :type: list[str]


      Return a list of author names.



   .. py:property:: subject_tags
      :type: list[str]


      Return a flat list of subject and child-subject names.



.. py:class:: OENTextbookList

   Bases: :py:obj:`pydantic.RootModel`\ [\ :py:obj:`list`\ [\ :py:obj:`OENTextbook`\ ]\ ]


   A list of Open Education Network textbooks.


.. py:data:: here