Skip to content

API reference#

These pages list the stable public API of the bookshelf package. Everything documented here follows Semantic Versioning, so a breaking change to any of it only lands in a new major version.

Import every name from the top-level package, for example from bookshelf import Bookshelf.

Page Covers
Bookshelf The client that finds volumes and resolves books
Volumes A volume and the versions and editions it publishes
Books A published book and the entries it indexes
Resources The bytes behind an entry, read as frames or files
Errors The exceptions a caller can catch

Outside the promise#

Anything not on these pages can change in any release, even when it is importable. This includes:

  • Underscore-prefixed modules, such as bookshelf._core, are internal.
  • The producer surface is not covered yet. That means Bookshelf.activity, Bookshelf.draft_book and the volume and draft management methods.
  • bookshelf.publisher drives recording, replaying and publishing bundles, and is not covered.
  • bookshelf.models holds the generated API models. Methods above still return some of these, but their fields track the platform API.
  • The transport and async_transport arguments exist for tests.
  • The bookshelf command line interface is not covered.