summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2021-10-29 10:50:01 -0700
committerBryan Newbold <bnewbold@archive.org>2021-10-29 10:50:01 -0700
commit66726f45e53bdcd3f8876e640c285ebd0cb2751f (patch)
treeeadcae58733ee3d32795bf09ce278f4b441acbd3
parent2c4aba8dbc0d548f0007000c9297a39d4ab67fe2 (diff)
downloadgrobid_tei_xml-66726f45e53bdcd3f8876e640c285ebd0cb2751f.tar.gz
grobid_tei_xml-66726f45e53bdcd3f8876e640c285ebd0cb2751f.zip
update README to use process_citation_xml()
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 2b06da1..8bd31b8 100644
--- a/README.md
+++ b/README.md
@@ -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)
```