MyCapytain.api.rst

MyCapytain API Documentation

Utilities, metadata and references

Module common contains tools such as a namespace dictionary as well as cross-implementation objects, like URN, Citations...

Base

MyCapytain.common.base

Constants

MyCapytain.common.constants

URN, References and Citations

MyCapytain Base Objects

MyCapytain.common.reference.NodeId

MyCapytain.common.reference.BaseCitationSet

MyCapytain.common.reference.BaseReference

MyCapytain.common.reference.BaseReferenceSet

Canonical Text Services Objects

MyCapytain.common.reference.Citation

MyCapytain.common.reference.CtsReference

MyCapytain.common.reference.CtsReferenceSet

Distributed Text Services Objects

MyCapytain.common.reference.URN

MyCapytain.common.reference.DtsCitation

MyCapytain.common.reference.DtsCitationSet

Metadata containers

MyCapytain.common.metadata

Utilities

MyCapytain.common.utils

API Retrievers

Module endpoints contains prototypes and implementation of retrievers in MyCapytain

CTS 5 API

MyCapytain.retrievers.cts5

Prototypes

MyCapytain.retrievers.prototypes

Resolvers

Remote CTS API

MyCapytain.resolvers.cts.api.HttpCtsResolver

Local CapiTainS Guidelines CTS Resolver

MyCapytain.resolvers.cts.local.CtsCapitainsLocalResolver

Dispatcher

MyCapytain.resolvers.utils.CollectionDispatcher

Prototypes

MyCapytain.resolvers.prototypes.Resolver

Texts and inventories

Text

TEI based texts

MyCapytain.resources.texts.base.tei.TEIResource

Locally read text

MyCapytain.resources.texts.local.capitains.cts.CapitainsCtsText

MyCapytain.resources.texts.local.capitains.cts.CapitainsCtsPassage

MyCapytain.resources.texts.local.capitains.cts.__SimplePassage__

CTS API Texts

Formerly MyCapytain.resources.texts.api (< 2.0.0)

MyCapytain.resources.texts.remote.cts.CtsText

MyCapytain.resources.texts.remote.cts.CtsPassage

Collections

Metadata

MyCapytain.resources.prototypes.metadata

CTS inventory

MyCapytain.resources.collections.cts

CTS Inventory Prototypes

MyCapytain.resources.prototypes.cts.inventory

Text Prototypes

MyCapytain.resources.prototypes.text