README.md

Scaife Viewer :: Core functionality

This package was extracted from https://github.com/scaife-viewer/scaife-viewer

Settings

ALLOW_TRAILING_COLON

Default: False

When False, to maintain compatability with the MyCapitain resolver, the trailing colon will be stripped from URNs.

REDIRECT_VERSION_LIBRARY_COLLECTION_TO_READER

Default: True

When True, will redirect a version / exemplar library_collection URL to the first passage of the version in the reader`

HOOKSET

Default: "scaife_viewer.core.hooks.DefaultHookSet"

The path to a hookset that can be used to customize package functionality.

hookset.content_manifest_path

Default: Callable returning pathlib.Path resolving to data/content-manifests/production.yaml

Can be customized via the CONTENT_MANIFEST_PATH env var.

RESOLVER_CACHE_LABEL

Default: "cts-resolver"

The label to use for the cache backend that holds cached resolver data

USE_CLOUD_INDEXER

Default: False

When True, sets GCE-specific metadata for the search index management command

CLI

For information about the CLI:

scaife --help