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.0-cp39-abi3-manylinux_2_28_aarch64.whl (3.6 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.28+ ARM64

opendqi-0.15.0-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.0-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.0-cp39-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for opendqi-0.15.0-cp39-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 8c24c8ab165079010c4885a6e9a8f623a7bbffa6efeadf48c1bd69796108e6e1
MD5 9d68f36047318b1a49ee8a68c9f7ef25
BLAKE2b-256 14da65f39c3e2e480a12b7c4531eada7d789125814cb7acc371566c6e77aecea

See more details on using hashes here.

Provenance

The following attestation bundles were made for opendqi-0.15.0-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.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for opendqi-0.15.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9e4e903f8bf631dade4f2e74112b26e0cbca97802057a80571e0d4e99eb595d2
MD5 916c2f7a129ac4219c547ebeb82be9eb
BLAKE2b-256 c3a998dfaac2e0aac8e38f0d8e90b8f75c632d6fea66e114f6efcc25e9cdedd3

See more details on using hashes here.

Provenance

The following attestation bundles were made for opendqi-0.15.0-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.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for opendqi-0.15.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a9e87f504907e6b8c7784a1ec67aaa9370238f7d398c3b54cb8876f27c9aef95
MD5 b9a85f631a508ab2a3ac6253d11347db
BLAKE2b-256 4c9ddbe6bceecdbbdbea5808afe10e3b6dcbc3594bd38db80781b409d0a41bb7

See more details on using hashes here.

Provenance

The following attestation bundles were made for opendqi-0.15.0-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