Reference¶
build module¶
build XML data in CMI format
-
cmif.build.
add_attrib
(element, name, value)¶ add attribute to element if value != “”
-
cmif.build.
add_child
(parent, element)¶ add element to parent if not None
-
cmif.build.
add_children
(parent, elements)¶ add elements to parent if not None
-
cmif.build.
add_pi
(tree)¶ add processing instruction <?xml-model?> to given element tree
-
cmif.build.
ns_cs
(attrib)¶ add correspSearch namespace to given attribute
-
cmif.build.
ns_xml
(attrib)¶ add xml namespace to given attribute
-
cmif.build.
pi_rng
()¶ create processing instruction <?xml-model?>
-
cmif.build.
pretty
(element)¶ pretty print given elements
-
cmif.build.
tei_availability
(child_license=None)¶ create TEI element <availability> with (optional) child element <licence>
-
cmif.build.
tei_bibl
(elem_text, attrib_type, attrib_xml_id=None, domain=None)¶ - create TEI element <bibl> with given text, @type and (optional) @xml:idif @xml:id is None a uuid is being generatedif domain is None the uuid will be randomif domain is not None the uuid will be static
-
cmif.build.
tei_bibl_id
(domain=None)¶ - generate uuid for @xml:id of TEI element <bibl> by given domainif domain is None a random uuid is being generated
-
cmif.build.
tei_body
()¶ create TEI element <body>
-
cmif.build.
tei_corresp_action
(attrib_type, children=None)¶ create TEI element <correspAction> with @type and (optional) children
-
cmif.build.
tei_corresp_desc
(attrib_key='', attrib_ref='', attrib_source='', children=None)¶ create TEI element <correspDesc> with @ref, @source and (optional) children
-
cmif.build.
tei_date
(attrib_when='', attrib_from='', attrib_to='', attrib_not_before='', attrib_not_after='', attrib_evidence=None, attrib_cert=None)¶ - create TEI element <date> with @when, @from, @to, @notBefore or @notAfterand (optional) @evidence and @cert
-
cmif.build.
tei_editor
(elem_text)¶ create TEI element <editor> with given element text
-
cmif.build.
tei_email
(elem_text)¶ create TEI element <email> with given element text
-
cmif.build.
tei_file_desc
(children=None)¶ create TEI element <fileDesc> with (optional) children
-
cmif.build.
tei_header
(children=None)¶ create TEI element <teiHeader> with (optional) children
-
cmif.build.
tei_idno
(elem_text, attrib_type='url')¶ create TEI element <idno> with @type
-
cmif.build.
tei_license
(elem_text='', attrib_target='')¶ create TEI element <licence> with (optional) text and @target
-
cmif.build.
tei_org_name
(elem_text, attrib_ref='', attrib_evidence=None, attrib_cert=None)¶ - create TEI element <orgName> with given element text, @refand (optional) @evidence and @cert
-
cmif.build.
tei_p
()¶ create TEI element <p>
-
cmif.build.
tei_pers_name
(elem_text, attrib_ref='', attrib_evidence=None, attrib_cert=None)¶ - create TEI element <persName> with given element text, @refand (optional) @evidence and @cert
-
cmif.build.
tei_place_name
(elem_text, attrib_ref='', attrib_evidence=None, attrib_cert=None)¶ - create TEI element <placeName> with given element text, @refand (optional) @evidence and @cert
-
cmif.build.
tei_profile_desc
(children=None)¶ create TEI element <profileDesc> with (optional) children
-
cmif.build.
tei_publication_stmt
(children=None)¶ create TEI element <publicationStmt> with (optional) children
-
cmif.build.
tei_publisher
(child_ref=None)¶ create TEI element <publisher> with (optional) child element <ref>
-
cmif.build.
tei_ref
(elem_text, attrib_target)¶ create TEI element <ref> with @target
-
cmif.build.
tei_root
(children=None)¶ create TEI root element <TEI> with (optional) children
-
cmif.build.
tei_source_desc
(children=None)¶ create TEI element <sourceDesc> with (optional) children
-
cmif.build.
tei_text
()¶ create TEI element <text>
-
cmif.build.
tei_text_empty
()¶ create TEI element <text> with child elements <body> and <p> (empty)
-
cmif.build.
tei_title
(elem_text)¶ crate TEI element <title> with given element text
-
cmif.build.
tei_title_stmt
(children=None)¶ create TEI element <titleStmt> with (optional) children
-
cmif.build.
tostr
(element)¶ convert given element to str
extract module¶
extract XML data in CMI format
-
cmif.extract.
bibl
(data, multi=False)¶ - extract TEI element <bibl>set multi to True if multiple references exist
-
cmif.extract.
bibl_id
(data, multi=False)¶ - extract @xml:id from TEI element <bibl>set multi to True if multiple references exist
-
cmif.extract.
bibl_text
(data, multi=False)¶ - extract text of TEI element <bibl>set multi to True if multiple references exist
-
cmif.extract.
bibl_type
(data, multi=False)¶ - extract @type from TEI element <bibl>set multi to True if multiple references exist
-
cmif.extract.
correspaction
(data)¶ extract TEI elements <correspAction>
-
cmif.extract.
correspaction_type
(data)¶ extract @type from TEI elements <correspAction>
-
cmif.extract.
correspdesc
(data)¶ extract TEI elements <correspDesc>
-
cmif.extract.
correspdesc_key
(data)¶ extract @source from TEI elements <correspDesc>
-
cmif.extract.
correspdesc_source
(data)¶ extract @source from TEI elements <correspDesc>
-
cmif.extract.
date_attrib
(data)¶ extract @ from TEI element <date>
-
cmif.extract.
date_from
(data)¶ extract @when from TEI element <date>
-
cmif.extract.
date_not_after
(data)¶ extract @when from TEI element <date>
-
cmif.extract.
date_not_before
(data)¶ extract @when from TEI element <date>
-
cmif.extract.
date_to
(data)¶ extract @when from TEI element <date>
-
cmif.extract.
date_when
(data)¶ extract @when from TEI element <date>
-
cmif.extract.
editor
(data, multi=False)¶ - extract TEI element <editor>set multi to True if multiple editors exist
-
cmif.extract.
editor_email
(data, multi=False)¶ - extract text of TEI element <email> from parent <editor>set multi to True if multiple editors exist
-
cmif.extract.
editor_name
(data, multi=False)¶ - extract text of TEI element <editor>set multi to True if multiple editors exist
-
cmif.extract.
idno
(data)¶ extract text from TEI element <idno>
-
cmif.extract.
license
(data)¶ extract text of TEI element <licence>
-
cmif.extract.
license_target
(data)¶ extract @target from TEI element <licence>
-
cmif.extract.
org_name
(data)¶ extract text from TEI element <orgName>
-
cmif.extract.
org_name_ref
(data)¶ extract @ref from TEI element <orgName>
-
cmif.extract.
pers_name
(data)¶ extract text from TEI element <persName>
-
cmif.extract.
pers_name_ref
(data)¶ extract @ref from TEI element <persName>
-
cmif.extract.
place_name
(data)¶ extract text from TEI element <placeName>
-
cmif.extract.
place_name_ref
(data)¶ extract @ref from TEI element <placeName>
-
cmif.extract.
publisher
(data)¶ extract text from child <ref> of TEI element <publisher>
-
cmif.extract.
publisher_target
(data)¶ extract @target from child <ref> of TEI element <publisher>
-
cmif.extract.
title
(data)¶ extract text of TEI element <title>
demo module¶
demo XML data in CMI format
-
cmif.demo.
gottsched
()¶ get data of Gottsched’s Briefwechsel as demo for CMI-format
-
cmif.demo.
wieland
()¶ get data of Wieland’s Briefe (1750-1760) as demo for CMI-format
local module¶
read and write local XML data in CMI format
-
cmif.local.
reader
(filepath)¶ read xml data from given file path
-
cmif.local.
writer
(root, file='cmif.xml', path='.')¶ write given root element to file at path
retrieve module¶
retrieve remote XML data in CMI format
-
cmif.retrieve.
remote_file
(url)¶ send http get request to given url
service module¶
access data in CMI format through correspSearch webservices
-
cmif.service.
correspsearch
(correspondent=None, sender=None, addressee=None, startdate=None, enddate=None, place=None, placeSender=None, placeAddressee=None, cmiFile=None, publication=None, available=None, strictDate=False, endpoint='https://correspsearch.net/api/v1.1/tei-xml.xql')¶ - query data in CMI format via correspSearch API by given parametersavailable endpoints: TEI_XML (default) / TEI_JSONsee https://correspsearch.net/index.xql?id=api for details
authority module¶
search or retrieve GeoNames
you need to set the environment variable GEO_USER like this:
$ export GEO_USER=[my-geonames-account-username]
or pass the variable username as parameter to the functions!
request GeoNames entity by given id (requires GeoNames username)
search GeoNames entity for given place (requires GeoNames username)