diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -24,10 +24,10 @@ Install using `pip`, usually within a `virtualenv`: pip install grobid_tei_xml -The main entry points are the function `process_document_xml(xml_text)` and -`process_citations_xml(xml_text)`, which return python dataclass objects. The -helper method `.to_dict()` can be useful for, eg, serializing these objects to -JSON. +The main entry points are the functions `process_document_xml(xml_text)` and +`process_citation_xml(xml_text)` (or `process_citation_list_xml(xml_text)` for +multiple citations), which return python dataclass objects. The helper method +`.to_dict()` can be useful for, eg, serializing these objects to JSON. ## Usage Examples @@ -97,7 +97,7 @@ grobid_resp = requests.post( ) grobid_resp.raise_for_status() -citation = grobid_tei_xml.parse_citations_xml(grobid_resp.text)[0] +citation = grobid_tei_xml.parse_citation_xml(grobid_resp.text) print(citation) ``` |