pressbooks.pressbooks_models
============================

.. py:module:: pressbooks.pressbooks_models


Attributes
----------

.. autoapisummary::

   pressbooks.pressbooks_models.PRESSBOOKS_LICENSE_TO_SPDX
   pressbooks.pressbooks_models.here


Classes
-------

.. autoapisummary::

   pressbooks.pressbooks_models.PressbooksBookTitle
   pressbooks.pressbooks_models.PressbooksBookMetadata
   pressbooks.pressbooks_models.PressbooksBook


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

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

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

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


   WordPress REST API title object.


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



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

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


   Pressbooks book metadata fields exposed by the network-catalog REST API.

   All fields are optional; missing keys arrive as empty strings.


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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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



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


      Return authors as a list, splitting on semicolons.



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


      Return subject tags as a list, splitting on commas.



   .. py:property:: spdx_license
      :type: str


      Translate the Pressbooks license slug to an SPDX expression.



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

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


   A single book record as returned by the Pressbooks Directory REST API.

   Endpoint: GET https://pressbooks.directory/wp-json/pressbooks/v2/books


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



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



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



   .. py:attribute:: metadata
      :type:  PressbooksBookMetadata
      :value: None



   .. py:method:: coerce_title(value: object) -> object
      :classmethod:


      Accept a plain string in addition to the standard {rendered: ...} dict.



   .. py:property:: book_url
      :type: str


      Return the best available URL for the book.



.. py:data:: here