Fatoority Python bindings
This package wraps Diplomat-generated native bindings with the public fatoora
Python API. Install with pip install fatoority and import as fatoora. See Diplomat bindings.
Development (uv)
uv venv
uv pip install .
Build a wheel (uv)
uv build --wheel
Wheels (CI)
- GitHub Actions uses
cibuildwheelto produce platform wheels indist/(wheel-only publishing). - See
.github/workflows/python.ymlfor the build matrix.
Notes
- The build step compiles
fatoora-ffiwithcargo build -p fatoora-ffi --release. - The shared library is bundled into the Python package.
- Building the native extension requires CMake and a C++20 compiler. Nanobind is pinned in the build dependencies. Reinstall the package after native changes.
- ZATCA API responses are exposed via opaque handles with getters (no JSON payloads).
- Errors are raised as typed exceptions mapped from FFI error codes (see
FfiErrorKind). Each exception exposes.code,.kind, and.details, a dictionary containing structured validation issues or diagnostics. Unknown codes remain available on a genericFfiError. - Reinstall the package after changes; the extension loads its bundled shared library.
Examples
python examples/load_lib.py
python examples/invoice_basic.py
python examples/invoice_parse.py
Tests
uv pip install -e .[dev]
SKIP_ZATCA_LIVE_API=1 uv run pytest tests
High-level API
from fatoora import InvoiceBuilder, InvoiceSubType, InvoiceTypeKind, VatCategory
builder = InvoiceBuilder.new(
invoice_type=InvoiceTypeKind.TAX,
invoice_subtype=InvoiceSubType.SIMPLIFIED,
)
builder.set_id("INV-1")
builder.set_uuid("123e4567-e89b-12d3-a456-426614174000")
builder.set_issue_datetime("2024-01-01T12:30:00Z")
builder.set_currency("SAR")
builder.set_previous_invoice_hash("hash")
builder.set_invoice_counter(1)
builder.set_payment_means_code("10")
builder.set_vat_category(VatCategory.STANDARD)
builder.set_seller(
name="Acme Inc",
country_code="SAU",
city="Riyadh",
street="King Fahd",
building_number="1234",
postal_code="12222",
vat_id="399999999900003",
)
builder.add_line_item(
description="Item",
quantity="1.0",
unit_code="PCE",
unit_price="100.0",
vat_rate="15.0",
vat_category=VatCategory.STANDARD,
)
invoice = builder.build()
print(invoice.xml())
set_issue_datetime expects a ZATCA ISO UTC timestamp string (YYYY-MM-DDTHH:MM:SSZ).
Local ZATCA validation
from fatoora import Config, validate_zatca_invoice_from_str
with Config() as config:
report = validate_zatca_invoice_from_str(
config, xml, previous_invoice_hash=previous_hash_from_history,
)
if not report["is_valid"]:
print(report["stages"])
The report retains warnings and distinguishes rejection from incomplete coverage.
Missing predecessor context leaves the report incomplete. Execution failures raise
a typed exception with any partial report in error.details["report"]. Standard
invoices skip signature/QR checks in this SDK profile. Local integrity does not
establish issuer trust or remote acceptance. The wheel embeds runtime schemas
and native rules; Java, SDK files and a source checkout are unnecessary.
1 maintainer
Metadata
1 maintainer
Release files for fatoority 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 81.9 MB
Release files / fatoority-0.4.1-cp313-cp313-win_amd64.whl
| Download URL | fatoority-0.4.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
4a492788e70ecec1559d59c63731ecd2ef10e9fbd501a66ab1464cd2d026eb9e
|
|
BLAKE2b-256 checksum How to use checksums |
94db4f9fe047c5618727bbbe4411d13c41398c4cc4a148d768164a575e5f4c1b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp313-cp313-manylinux_2_28_x86_64.whl
| Download URL | fatoority-0.4.1-cp313-cp313-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.8 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
34eb8146fb77752334a2fe843f71a7617d5c2d75c15f3f5f84ab9ac208937617
|
|
BLAKE2b-256 checksum How to use checksums |
a7f682079c578e975fce2a1afcff226a0dc7c73099686249cbaab0b71f35daae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | fatoority-0.4.1-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
8a529595442c8014a8666ce3025c1639012fc45c6383a19b0745f4b6aea45f22
|
|
BLAKE2b-256 checksum How to use checksums |
0ab7859217bac7318a5461acaaf5b3ff19caf8a2ab990b14be5089272b6a54af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp312-cp312-win_amd64.whl
| Download URL | fatoority-0.4.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
feb95f4275b29705c9624195b6c6cf5fa38cd74fbbfec5738cf040ac79ba229e
|
|
BLAKE2b-256 checksum How to use checksums |
2f6a86b46474c32b88fcb0b3c93577e7ca5276613ba86f0ec81b11a6435339df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp312-cp312-manylinux_2_28_x86_64.whl
| Download URL | fatoority-0.4.1-cp312-cp312-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.8 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
6db5cdc124a5a535b52bacc9ed0f7409fbca72f7dfc1fe6df3fcedd1e9485668
|
|
BLAKE2b-256 checksum How to use checksums |
fd67ef60b63867c06263bc145f520b1486e00017b41243411705980a746f7941
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | fatoority-0.4.1-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
b0c61e2a04ba5d36041d82d6d262e09bf908bffcd4b127cb1ac5c879feaad9da
|
|
BLAKE2b-256 checksum How to use checksums |
d894304b9eb992064f75d4453ba0581bcb2769a07017c0fc8dea92cad283a6f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp311-cp311-win_amd64.whl
| Download URL | fatoority-0.4.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
daf1157fa9901e6f0259a2ec090f503000be1b8b89b79291d640e1e1729f42ce
|
|
BLAKE2b-256 checksum How to use checksums |
2a4879c7092d4e76fb9878d0d9e18eb630b9bc58784df8fd7d3894084ac175d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp311-cp311-manylinux_2_28_x86_64.whl
| Download URL | fatoority-0.4.1-cp311-cp311-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.8 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
f5d5875304364d087d5ac804506b0974c84507cb74e77e7a17da2ab79abc5ab5
|
|
BLAKE2b-256 checksum How to use checksums |
1a78d93e352986dfcf6bb600e11998cdf5211beee2cca20d60161a6032acb887
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | fatoority-0.4.1-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
7d5b0c3546df909e134939428616967a886e8d65896cb9ac7773ef863c5d4aec
|
|
BLAKE2b-256 checksum How to use checksums |
a97b2ee617ff5a95b2197652974064bf70e870b8539b824a913394e19b8c19db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp310-cp310-win_amd64.whl
| Download URL | fatoority-0.4.1-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
986826c5ce5308cf6a88297b9cca3f803400fdcee222ed70341afe9253266233
|
|
BLAKE2b-256 checksum How to use checksums |
56b598213868b4680dfca79d4146965aa280b7b8ff27889e4696795ade0e0dda
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp310-cp310-manylinux_2_28_x86_64.whl
| Download URL | fatoority-0.4.1-cp310-cp310-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.8 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
c66b20e2fb68ff728494c8daa71df714c551e4347d929ac11d06a32918a42fe6
|
|
BLAKE2b-256 checksum How to use checksums |
e3790fe93f4353300e6119e76155c8306258c867184ec1647c15b8f42ca3645a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | fatoority-0.4.1-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a8106a7f3c89cbe4656ec47a789a2cafbb72bd3fdb3652ca34461cbd410bc5de
|
|
BLAKE2b-256 checksum How to use checksums |
d0b12febb4a97b892b0121cee24970ca41938b50b55dd03e797e588a36605de2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp39-cp39-win_amd64.whl
| Download URL | fatoority-0.4.1-cp39-cp39-win_amd64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.9 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
06b9cf217c1d1c77937da23895cc22d5419d7943053d99289e6d448537fa3998
|
|
BLAKE2b-256 checksum How to use checksums |
f1d138dd10809a79954263b2c51b544f0b18dbaa6452fc48f07234ee41c04f29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp39-cp39-manylinux_2_28_x86_64.whl
| Download URL | fatoority-0.4.1-cp39-cp39-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 5.8 MB |
| Tags | CPython 3.9 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
9ad4cd42ced91fcff90e7f3315696275c925fc4ff12637419d9b00d02f706980
|
|
BLAKE2b-256 checksum How to use checksums |
1c1a4ed7c43ec2b6217eef9d597d132936032b1370e6021ad3fd31cc0a6cc3eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency logRelease files / fatoority-0.4.1-cp39-cp39-macosx_11_0_arm64.whl
| Download URL | fatoority-0.4.1-cp39-cp39-macosx_11_0_arm64.whl |
|---|---|
| Size | 5.3 MB |
| Tags | CPython 3.9 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
9b36231ac05ab30a74e6c999104efe7e7b7df575d48b4d55ccd331a55c2ebecf
|
|
BLAKE2b-256 checksum How to use checksums |
a1af7b96a1837acd5a835ceb7e8a5295776b526c35c657f39f1889dce9f30695
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 11, 2026.
Transparency log
