pressbooks.pressbooks_models

Attributes

PRESSBOOKS_LICENSE_TO_SPDX

here

Classes

PressbooksBookTitle

WordPress REST API title object.

PressbooksBookMetadata

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

PressbooksBook

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

Module Contents

pressbooks.pressbooks_models.PRESSBOOKS_LICENSE_TO_SPDX: types.MappingProxyType[str, str]
class pressbooks.pressbooks_models.PressbooksBookTitle(/, **data: Any)

Bases: pydantic.BaseModel

WordPress REST API title object.

rendered: str = None
class pressbooks.pressbooks_models.PressbooksBookMetadata(/, **data: Any)

Bases: pydantic.BaseModel

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

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

pb_title: str = None
pb_subtitle: str = None
pb_short_title: str = None
pb_authors: str = None
pb_editors: str = None
pb_description: str = None
pb_publisher: str = None
pb_publisher_city: str = None
pb_publication_date: str = None
pb_keywords_tags: str = None
pb_subject: str = None
pb_language: str = None
pb_license: str = None
pb_cover_image: str = None
pb_url: str = None
property authors_list: list[str]

Return authors as a list, splitting on semicolons.

property subject_tags: list[str]

Return subject tags as a list, splitting on commas.

property spdx_license: str

Translate the Pressbooks license slug to an SPDX expression.

class pressbooks.pressbooks_models.PressbooksBook(/, **data: Any)

Bases: pydantic.BaseModel

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

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

id: int = None
title: PressbooksBookTitle = None
metadata: PressbooksBookMetadata = None
classmethod coerce_title(value: object) → object

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

property book_url: str

Return the best available URL for the book.

pressbooks.pressbooks_models.here