Textcavator Readers
textcavator-readers is a python module to extract data from a variety of formats, including CSV, XML, HTML, XLSX, JSON, and RDF.
This module was originally created for Textcavator, a web application that extracts data from a variety of datasets, indexes them and presents a search interface. To do this, we wanted a way to extract data from source files without having to write a new script "from scratch" for each dataset, and an API that would work the same regardless of the source file type.
The basic usage is that you will use the utilities in this package to create a "reader" class. You specify what your data looks like, and then call the documents() method of the reader to get an iterator of documents - where each document is a flat dictionary of key/value pairs.
Prerequisites
Requires Python 3.10 or later.
Contents
textcavator_readers contains the source code for the package. tests contains unit tests.
When to use this package
This package is not a replacement for more general-purpose libraries like csv or Beautiful Soup - it is a high-level interface on top of those libraries.
Our primary use for this package is to pre-process data for Textcavator, but you may find other uses for it.
Using this package makes sense if you want to extract data in the shape that it is designed for (i.e., a list of flat dictionaries).
What we find especially useful is that all subclasses of Reader have the same interface - regardless of whether they are processing CSV, JSON, XML, HTML, RDF or XLSX data. That common interface is crucial in an application that needs to process corpora from different source types, like Textcavator.
Usage
Typical usage of this package would be to make a custom Python class for a dataset from which you want to extract a list of documents. We call this a Reader. This package provides the base classes to structure readers, and provides extraction utilities for several file types.
For detailed usage documention and examples, visit textcavator-readers.readthedocs.io
If this site is unavailable, you can also generate the documentation site locally; see the contributing guide for insttructions.
Licence
This code is shared under an MIT licence. See LICENSE for more information.
Metadata
Release files for textcavator-readers 0.5.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 |
|---|---|---|---|---|
| textcavator_readers-0.5.1.tar.gz | 25.4 kB | With provenance | Details for textcavator_readers-0.5.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| textcavator_readers-0.5.1-py3-none-any.whl | Python 3 | none | any | Details for textcavator_readers-0.5.1-py3-none-any.whl |
Total release size: 52.9 kB
Release files / textcavator_readers-0.5.1.tar.gz
| Download URL | textcavator_readers-0.5.1.tar.gz |
|---|---|
| Size | 25.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37b1f7aef1212bdb0c3e5917a2d3a851130d9dfad798c3de7b5cab6362dbc3d3
|
|
BLAKE2b-256 checksum How to use checksums |
11ef4f1c200642e2f135d237d186f004d3a5f8f6310123036ac44501ac87f830
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 15, 2026.
Transparency logRelease files / textcavator_readers-0.5.1-py3-none-any.whl
| Download URL | textcavator_readers-0.5.1-py3-none-any.whl |
|---|---|
| Size | 27.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ebb51a52698ecb25b15e1d07697825dcb8917abec5656a35076912ec287de139
|
|
BLAKE2b-256 checksum How to use checksums |
8e17ce01dad1a920d2730cd9e2992d6a79e41d54bcdf50898e06dc53250c7d92
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 15, 2026.
Transparency logSecurity for textcavator-readers 0.5.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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for textcavator_readers-0.5.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 15, 2026.
Transparency logA 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.
