pagexml-tools
Utility functions for reading PageXML files
installing
using poetry
poetry add pagexml-tools
using pip
pip install pagexml-tools
Using
PageXML-tools contains functions for parsing and for a range of analysis tasks.
Parsing PageXML files and the Physical Document model
There is a tutorial that demonstrates the physical document model API
PageXML-tools contains basic functionality for parsing a PageXML file that returns a document model representing the content of the file. The HTR/OCR process that generates PageXML, recognises text in an image of a physical document.
from pagexml.parser import parse_pagexml_file
pagexml_file = "path/to/pagexml_file.xml"
page_doc = parse_pagexml_file(pagexml_file)
# a page document has an ID
print(page_doc.id)
# print descriptive statistics
print(page_doc.stats)
# iterative over text regions and lines
for tr in page_doc.text_regions:
# a text_region has an ID and a bounding box derived from its coordinates
print(tr.id, tr.coords.box)
# a text_region can have sub-text_regions and lines
for line in tr.lines:
# a line has an ID, coordinates and text
print(line.id, line.coords.box, line.text)
In addition to the basic parsing and handling of PageXML output, there is functionality to support a range of tasks:
- reading sets of PageXML files from a archive (tar, zip) file (tutorial),
- searching in text (keyword in context, keywords or fuzzy search)
- reading and working with tables (table processing)
- classifying physical document types in a large set of PageXML documents (tutorial),
- checking the quality of the HTR/OCR process (tutorial),
- comparing subsets (tutorial),
- identifying document sections in sequences of PageXML documents (tutorial),
- turning text lines into running text (tutorial),
- supporting different reading orders (tutorial),
- reinterpreting and restructuring text regions and lines (tutorial),
- turning physical structure into logical structure,
Using PageXML-tools in R:
#Python
# run in CMD (Command) first (first time only):
py -m pip install pagexml-tools
# Install and start Python 3.11 in background
# R
# run in different window in R first time only!
install.packages("reticulate")
# run in different window in R first:
library(reticulate)
# run in different window in R next:
py_require(c("pagexml-tools"))
# Import PageXML file parser:
from pagexml.parser import parse_pagexml_file
Thanks to Milan van Lange for this R example.
USAGE | CONTRIBUTING | LICENSE
Metadata
Release files for pagexml-tools 0.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pagexml_tools-0.9.1.tar.gz | 75.2 kB | Without provenance | Details for pagexml_tools-0.9.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pagexml_tools-0.9.1-py3-none-any.whl | Python 3 | none | any | Details for pagexml_tools-0.9.1-py3-none-any.whl |
Total release size: 160.3 kB
Release files / pagexml_tools-0.9.1.tar.gz
| Download URL | pagexml_tools-0.9.1.tar.gz |
|---|---|
| Size | 75.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff270997ac825185866d9e9f0cabe1fa1d430d7ab07dbc8ea86b525ac5c148ed
|
|
BLAKE2b-256 checksum How to use checksums |
968f7bb9f8e04b71837a81c9d952d037a8bbd28cb1c90c7200633faf8f27ba90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.13.17 Darwin/27.0.0
|
Release files / pagexml_tools-0.9.1-py3-none-any.whl
| Download URL | pagexml_tools-0.9.1-py3-none-any.whl |
|---|---|
| Size | 85.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
68bdef0aff2af708ff4818073467c632ed63f00fd3c3f0f44a110f018829078e
|
|
BLAKE2b-256 checksum How to use checksums |
1395750732a5115d807c377d896377fd81cc50bb864b93709d875a0bc095fe1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.3 CPython/3.13.17 Darwin/27.0.0
|
Security for pagexml-tools 0.9.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.