Skip to content

Commit a2b7e5f

Browse files
committed
docs: Add documentation for standalone TEI to JSON and TEI to Markdown conversion tools.
1 parent cb18d20 commit a2b7e5f

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

Readme.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ client.process(
224224
markdown_output=True
225225
)
226226

227+
```python
227228
# Process citation lists
228229
client.process(
229230
service="processCitationList",
@@ -232,6 +233,32 @@ client.process(
232233
)
233234
```
234235

236+
### Standalone Conversion Tools
237+
238+
The library includes standalone scripts to convert TEI XML files to other formats without using the main client or server.
239+
240+
#### TEI to JSON Converter
241+
242+
Converts TEI XML files to the structured JSON format (similar to `--json` option).
243+
244+
```bash
245+
# Convert a single file
246+
python -m grobid_client.format.TEI2LossyJSON_cli --input path/to/file.tei.xml --output path/to/output.json
247+
248+
# Convert with verbose logging
249+
python -m grobid_client.format.TEI2LossyJSON_cli --input path/to/file.tei.xml --verbose
250+
```
251+
252+
#### TEI to Markdown Converter
253+
254+
Converts TEI XML files to Markdown format (similar to `--markdown` option).
255+
256+
```bash
257+
# Convert a single file
258+
python -m grobid_client.format.TEI2Markdown_cli --input path/to/file.tei.xml --output path/to/output.md
259+
```
260+
261+
235262
## ⚙️ Configuration
236263

237264
Configuration can be provided via a JSON file. When using the CLI, the `--server` argument overrides the config file

0 commit comments

Comments
 (0)