Skip to content

API documentation

The base class for the urn_citation package is Urn, with two subclasses: CtsUrn for CTS URNs and Cite2Urn for CITE2 URNs.

urn_citation.Urn

Bases: BaseModel

Superclass for URN types.

All URNs are required to have a type identifier.

Attributes:

Name Type Description
urn_type str

Required identifier for URN type.

Source code in src/urn_citation/urn.py
 3
 4
 5
 6
 7
 8
 9
10
11
12
class Urn(BaseModel):
    """Superclass for URN types.

    All URNs are required to have a type identifier.

    Attributes:
        urn_type (str): Required identifier for URN type.

    """    
    urn_type: str

The subclasses