Skip to main content

Local-first EMIR/SFTR data quality engine — Python / Arrow bindings

Project description

opendqi (Python / Arrow bindings)

Python bindings to the OpenDQI EMIR/SFTR data-quality engine. Wraps the Rust core in a small PyO3

  • Arrow C Data Interface layer; the engine itself is not reimplemented — every parser, every check, the streaming sink and the canonical record model are reused as-is.

Status

Preview (v0.12.x). See ../../docs/python-roadmap.md for the milestone breakdown. P1 ships the package skeleton (no functions yet) ; P2–P5 add scan_parquet, DqIssue → pyarrow. Table (the v1.0 contract), scan_table(arrow_tbl, mapping), parse_xml, and the result.normalized Arrow output.

Install (when v0.12.0 is released)

# From the GitHub Release tarballs:
pip install https://github.com/PauFou/OpenDQI/releases/download/v0.12.0/opendqi-0.12.0-cp39-abi3-<target>.whl

PyPI publication is gated on a separate explicit-user-ask release. For now the wheels live on the GitHub Releases page.

Local development

# From the repo root, with Python 3.9–3.13 (3.14 supported as a
# runtime target via abi3-py39 but the build script of PyO3 0.22
# needs >= 3.13 — see the spec for details).
python3.12 -m venv crates/opendqi-py/.venv
source crates/opendqi-py/.venv/bin/activate
pip install --upgrade pip maturin pytest pyarrow

cd crates/opendqi-py
maturin develop                # build the cdylib + install in the venv
pytest tests/                  # run the smoke tests
python -c "import opendqi; print(opendqi.__version__)"

Public API (target — surface grows commit-by-commit through P5)

import opendqi

# P2 — path-based scan, summary only.
result = opendqi.emir.scan_parquet("tsr.parquet")
result.summary        # dict — same fields as summary.json

# P3 — DqIssue → pyarrow.Table (v1.0 stable schema, byte-equal to
# the existing issues.csv).
result.issues         # pyarrow.Table | None

# P4 — Arrow-in surface with a canonical-field → user-column mapping.
import pyarrow as pa
table = pa.table({...})
result = opendqi.emir.scan_table(table, mapping={
    "uti":                  "UTI",
    "valuation_timestamp":  "ValuationTimestamp",
})

# P4 (bonus) — parse any of the 12 ISO 20022 messages directly.
records = opendqi.emir.parse_xml("auth107.xml")  # pyarrow.Table

# P5 — optional normalized output (RecordBatch of the canonical model).
result = opendqi.emir.scan_parquet("tsr.parquet", normalize=True)
result.normalized     # pyarrow.Table | None

License

Apache-2.0 — same as the parent OpenDQI repository. See ../../LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

opendqi-0.15.1-cp39-abi3-manylinux_2_28_aarch64.whl (3.6 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.28+ ARM64

opendqi-0.15.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.0 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

opendqi-0.15.1-cp39-abi3-macosx_11_0_arm64.whl (3.4 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

File details

Details for the file opendqi-0.15.1-cp39-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for opendqi-0.15.1-cp39-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 7fb254458fad129c3ed997e43c4b85249cbb8dfa4dec9fb2c74c4a39d1c47ddc
MD5 6a649859bb46b0f4b4b8d19381810cf4
BLAKE2b-256 be80007a18f56628174fd8bdf15e1e3fd1e7296accebeed43f93faaa560ffe38

See more details on using hashes here.

Provenance

The following attestation bundles were made for opendqi-0.15.1-cp39-abi3-manylinux_2_28_aarch64.whl:

Publisher: python-release.yml on PauFou/OpenDQI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opendqi-0.15.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for opendqi-0.15.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 909040c78fcb355caa6aa5145b94f66237f68ef60b123f64bd9c1c52e307960d
MD5 b4e207d881d391cc8ce21341db4dc802
BLAKE2b-256 9be91b85e09fadba53745a0948c6d68b5677813500177ebea426ce8bd500a72f

See more details on using hashes here.

Provenance

The following attestation bundles were made for opendqi-0.15.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: python-release.yml on PauFou/OpenDQI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file opendqi-0.15.1-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for opendqi-0.15.1-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 adebe23fab2c33c4a9b4b81ab92c956e5ee3b32fe27738af75ac771e89b306a0
MD5 214b5ec96f6b74c98ef163cef0f461ab
BLAKE2b-256 0bde32cbda4aa61be0b8c1534043bdd038224f6205295b617ba14a2cb700fd97

See more details on using hashes here.

Provenance

The following attestation bundles were made for opendqi-0.15.1-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: python-release.yml on PauFou/OpenDQI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page