Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xennis/epidoc-parser
Parser for EpiDoc (Epigraphic Documents in TEI XML)
https://github.com/xennis/epidoc-parser
epidoc epigraphy papyri parser tei-xml
Last synced: 1 day ago
JSON representation
Parser for EpiDoc (Epigraphic Documents in TEI XML)
- Host: GitHub
- URL: https://github.com/xennis/epidoc-parser
- Owner: Xennis
- License: mit
- Created: 2020-04-05T21:38:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T23:00:58.000Z (4 months ago)
- Last Synced: 2024-07-16T03:02:33.573Z (4 months ago)
- Topics: epidoc, epigraphy, papyri, parser, tei-xml
- Language: Python
- Homepage: https://xennis.github.io/epidoc-parser/
- Size: 77.1 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EpiDoc Parser
[](https://github.com/Xennis/epidoc-parser/actions/workflows/python.yml?query=event%3Apush+branch%3Amaster)
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).
## Usage
### Installation
Install the package
```shell
pip install git+https://github.com/Xennis/epidoc-parser
```
### Load a document
Load a document from a file
```python
import epidoc
with open("my-epidoc.xml") as f:
doc = epidoc.load(f)
```
Load a document from a string
```python
import epidoc
my_epidoc = """
[...]
"""
doc = epidoc.loads(my_epidoc)
```
### Get data from a document
Call the attributes, for example
```python
>>> doc.title
"Ordre de paiement"
>>> doc.material
"ostrakon"
>>> doc.languages
{"en": "Englisch", "la": "Latein", "el": "Griechisch"}
>>> [t.get("text") for t in doc.terms]
["Anweisung", "Zahlung", "Getreide"]
>>> doc.origin_place.get("text")
"Kysis (Oasis Magna)"
>>> doc.origin_dates[0]
{"notbefore": "0301", "notafter": "0425", "precision": "low", "text": "IV - Anfang V"}
```
## Documentation
| Field | EpiDoc source element (XPath) |
|---------------------------|--------------------------------------------------------------------------------|
| commentary | `//body/div[@type='commentary' and @subtype='general']` |
| edition_foreign_languages | `//body/div[@type='edition']//foreign/@xml:lang` |
| edition_language | `//body/div[@type='edition']/@xml:lang` |
| idno | `//teiHeader/fileDesc/publicationStmt/idno` |
| authority | `//teiHeader/fileDesc/publicationStmt/authority` |
| availability | `//teiHeader/fileDesc/publicationStmt/availability` |
| languages | `//teiHeader/profileDesc/langUsage/language` |
| material | `//teiHeader/fileDesc/sourceDesc/msDesc/physDesc/objectDesc//support/material` |
| origin_dates | `//teiHeader/fileDesc/sourceDesc/msDesc/history/origin/origDate` |
| origin_place | `//teiHeader/fileDesc/sourceDesc/msDesc/history/origin/origPlace` |
| provenances | `//teiHeader/fileDesc/sourceDesc/msDesc/history/provenance` |
| reprint_from | `//body/ref[@type='reprint-from']` |
| reprint_in | `//body/ref[@type='reprint-in']` |
| terms | `//teiHeader/profileDesc/textClass//term` |
| title | `//teiHeader/fileDesc/titleStmt/title` |
## Development
Create a virtual environment, enable it and install the dependencies
```shell
python3 -m venv venv
. venv/bin/activate
pip install --requirement requirements.txt
```
Run the test
```shell
make unittest
```
## LICENSE
### Code
see [LICENSE](LICENSE)
### Test data
The test data in this project is from the project [idp.data](https://github.com/papyri/idp.data) by [Papyri.info](http://papyri.info). This data is made available under a [Creative Commons Attribution 3.0 License](http://creativecommons.org/licenses/by/3.0/), with copyright and attribution to the respective projects.