palace-opds

Pydantic models for the OPDS and Readium family of specifications used in digital-library publishing — read, validate, and emit feed and license documents with type-safe Python objects.

What's covered

OPDS 2.0 publication and feed documents, including facets, navigation groups, and publication groups.
Readium Web Publication Manifest (RWPM) — link models, presentation hints, encryption metadata.
OPDS for Distributors / Authentication for OPDS 1.0 — authentication documents and link relations.
ODL 1.0 (Open Distribution to Libraries) — license metadata, terms, protection, loan/checkout status.
LCP (Readium Licensed Content Protection) — license documents and loan-status (LSD) documents.
W3C accessibility metadata and schema.org publication vocabulary for the slices that OPDS feeds reference.
Palace-specific extensions to the publication metadata vocabulary (under palace.opds.palace) — these can be safely ignored if you don't need them.

Installation

pip install palace-opds   # or: uv add palace-opds

Requires Python 3.12+.

Quick example

from palace.opds.opds2 import PublicationFeed

feed = PublicationFeed.model_validate_json(raw_feed_bytes)
for publication in feed.publications:
    print(publication.metadata.title, publication.metadata.identifier)

Models live under the palace.opds namespace and follow Pydantic v2 conventions, so they serialize to/from JSON and dictionaries with .model_dump() / .model_validate().

Design

Spec-faithful, not opinionated. Where the OPDS / Readium specs allow flexibility, the models accept it; we don't impose application-specific constraints.
Lean dependencies. Only the validation and serialization libraries the models actually need (pydantic, pycountry, uritemplate) — no web framework, ORM, or cloud SDK is pulled in transitively.
Stable, documented breakage. Breaking changes follow semver and are called out in release notes; minor releases are additive.

Project context

palace-opds is developed and maintained as part of the Palace Project, where it powers OPDS ingestion and feed generation for the Palace Manager digital-library backend. It's published as a standalone package because the OPDS specs are widely shared — other library systems, ingestion pipelines, or research tools that work with OPDS feeds can use these models without taking on Palace Manager as a dependency.

Outside contributions and bug reports are welcome via the ThePalaceProject/circulation repository, where this package is developed as a uv workspace member.

License

Apache 2.0.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

palace_opds-45.2.0.tar.gz (26.3 kB view details)

Uploaded Aug 9, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

palace_opds-45.2.0-py3-none-any.whl (36.7 kB view details)

Uploaded Aug 9, 2026 Python 3

File details

Details for the file palace_opds-45.2.0.tar.gz.

File metadata

Download URL: palace_opds-45.2.0.tar.gz
Upload date: Aug 9, 2026
Size: 26.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for palace_opds-45.2.0.tar.gz
Algorithm	Hash digest
SHA256	`3e471465345fb92fc572117939cfd3c793e3e82c8e21e1933de17192ccdaa10f`
MD5	`6ce44b498015b697c18eda06c5e29faa`
BLAKE2b-256	`8c5a5c9b6b69a94bed0fb99710879b289c85b834e5a8ca02480e94a938cd65fd`

See more details on using hashes here.

Provenance

The following attestation bundles were made for palace_opds-45.2.0.tar.gz:

Publisher: publish-pypi.yml on ThePalaceProject/circulation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: palace_opds-45.2.0.tar.gz
- Subject digest: 3e471465345fb92fc572117939cfd3c793e3e82c8e21e1933de17192ccdaa10f
- Sigstore transparency entry: 2387805879
- Sigstore integration time: Aug 9, 2026
Source repository:
- Permalink: ThePalaceProject/circulation@1c7746f42ee345c39b7b0b43e1c9a30fcb72d2ac
- Branch / Tag: refs/tags/v45.2.0
- Owner: https://github.com/ThePalaceProject
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish-pypi.yml@1c7746f42ee345c39b7b0b43e1c9a30fcb72d2ac
- Trigger Event: release