Skip to main content

I-analyzer Readers

Python package Documentation Status

ianalyzer-readers is a python module to extract data from XML, HTML, CSV, JSON, XLSX or RDF (Linked Data) files.

This module was originally created for I-analyzer, 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.9 or later.

Contents

ianalyzer_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 I-analyzer, 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 I-analyzer.

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 ianalyzer-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 ianalyzer-readers 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ianalyzer-readers 0.4.0
File Size Uploaded Provenance Actions
ianalyzer_readers-0.4.0.tar.gz 24.6 kB With provenance Details for ianalyzer_readers-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ianalyzer-readers 0.4.0
File Interpreter ABI Platform Actions
ianalyzer_readers-0.4.0-py3-none-any.whl Python 3 none any Details for ianalyzer_readers-0.4.0-py3-none-any.whl

Total release size: 51.0 kB

Release files / ianalyzer_readers-0.4.0.tar.gz

Download URL ianalyzer_readers-0.4.0.tar.gz
Size 24.6 kB
Tags Source
SHA-256 checksum
How to use checksums
cc1e8ac93ef01b3490db3c27a5e8f3d2ee311549882fd20282eef2f8cd2ffb8e
BLAKE2b-256 checksum
How to use checksums
bcd827332d13bee734b5d4bd5c7bea31b9cae6355b43afaaa7e7d4ea5a48880b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Oct 10, 2025.

Transparency log

Release files / ianalyzer_readers-0.4.0-py3-none-any.whl

Download URL ianalyzer_readers-0.4.0-py3-none-any.whl
Size 26.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
091bc9dd64975c5b3cda1c366965a48a8a0639b09c8c8201abe8f1786c78031e
BLAKE2b-256 checksum
How to use checksums
c33eb10f49d69a214a89bb676a7afcb4b348a00134191a43b131ab4a30474e4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Oct 10, 2025.

Transparency log

Security for ianalyzer-readers 0.4.0

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.

Select from 2 files

Attestation for ianalyzer_readers-0.4.0.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 Oct 10, 2025.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page