Skip to content

Update README.md #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xennis merged 1 commit into from
Sep 24, 2025
Merged

Update README.md #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Python parser for EpiDoc (epigraphic documents in TEI XML).

For example [idp.data-sheet](https://github.com/Xennis/idp.data-sheet) uses the parser to generate a single CSV sheet of the [Papyri.info Integrating Digital Papyrology data](https://github.com/papyri/idp.data).
For example [idp.data-sheet](https://github.com/Xennis/idp.data-search) uses the parser to generate a single CSV sheet of the [Papyri.info Integrating Digital Papyrology data](https://github.com/papyri/idp.data).

## Usage

Expand All @@ -19,15 +19,15 @@ pip install git+https://github.com/Xennis/epidoc-parser

Load a document from a file
```python
import epidoc
import epidoc_parser

with open("my-epidoc.xml") as f:
doc = epidoc.load(f)
doc = epidoc_parser.load(f)
```

Load a document from a string
```python
import epidoc
import epidoc_parser

my_epidoc = """<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="http://www.stoa.org/epidoc/schema/8.13/tei-epidoc.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0"?>
Expand All @@ -36,7 +36,7 @@ my_epidoc = """<?xml version="1.0" encoding="UTF-8"?>
</TEI>
"""

doc = epidoc.loads(my_epidoc)
doc = epidoc_parser.loads(my_epidoc)
```

### Get data from a document
Expand Down