beliq 0.1.0__tar.gz

beliq-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check src tests
+      - run: mypy
+      # Includes tests/test_spec_contract.py, which fails if the hand-written
+      # contracts drift from the vendored openapi.json.
+      - run: pytest

beliq-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+# Publishes beliq to PyPI via Trusted Publishing (OIDC) - no API token needed.
+# Attestations are generated automatically. Trigger by pushing a version tag
+# (e.g. v0.1.1) or running the workflow manually.
+#
+# One-time setup on pypi.org: register beliq-eu/beliq-sdk-python as a Trusted
+# Publisher for the beliq project (workflow `release.yml`, environment `pypi`).
+# Prefer a pending publisher so the very first tag run creates the project via
+# OIDC with no local upload.
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check src tests
+      - run: mypy
+      - run: pytest
+
+  publish:
+    needs: test
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for PyPI Trusted Publishing (OIDC)
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - name: Build
+        run: |
+          python -m pip install build
+          python -m build
+      # No `password`: the action exchanges the GitHub OIDC token with PyPI.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

beliq-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv
+__pycache__
+*.pyc
+dist
+build
+*.egg-info
+.mypy_cache
+.ruff_cache
+.pytest_cache
+.DS_Store

beliq-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) beliq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

beliq-0.1.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: beliq
+Version: 0.1.0
+Summary: Official beliq SDK: generate, validate, parse, and convert EU-compliant e-invoices (XRechnung, ZUGFeRD, Factur-X, Peppol BIS) against authority-pinned, drift-checked rules.
+Project-URL: Homepage, https://beliq.eu
+Project-URL: Repository, https://github.com/beliq-eu/beliq-sdk-python
+Project-URL: Issues, https://github.com/beliq-eu/beliq-sdk-python/issues
+Author-email: beliq <hello@beliq.eu>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: beliq,compliance,e-invoice,einvoice,en16931,factur-x,peppol,xrechnung,zugferd
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# beliq
+
+Official Python SDK for the [beliq](https://beliq.eu) e-invoicing compliance API. Generate, validate, parse, and convert EN 16931 invoices (XRechnung, ZUGFeRD, Factur-X, Peppol BIS) against authority-pinned, nightly-drift-checked rules.
+
+beliq produces and checks the compliant document. Transmission (Peppol, PDP, KSeF, SDI), archiving, and tax-authority reporting stay with your access point.
+
+## Install
+
+```bash
+pip install beliq
+```
+
+Requires Python >= 3.10.
+
+## Quick start
+
+```python
+from beliq import Beliq
+
+beliq = Beliq(api_key="blq_...")
+
+# Account, plan, and quota context (no quota cost).
+account = beliq.me()
+
+# Generate an XRechnung document from an EN 16931 invoice.
+generated = beliq.generate(
+    standard="xrechnung",
+    verify=True,
+    invoice={
+        "number": "INV-2026-001",
+        "issueDate": "2026-01-15",
+        "currencyCode": "EUR",
+        "seller": {"name": "Seller GmbH", "address": {"city": "Berlin", "postalCode": "10115", "countryCode": "DE"}},
+        "buyer": {"name": "Buyer GmbH", "address": {"city": "Munich", "postalCode": "80331", "countryCode": "DE"}},
+        "lines": [
+            {"description": "Consulting", "quantity": 10, "unitCode": "HUR", "unitPrice": 100, "lineTotal": 1000, "vatRate": 19, "vatCategoryCode": "S"}
+        ],
+        "totalNetAmount": 1000,
+        "totalTaxAmount": 190,
+        "totalGrossAmount": 1190,
+    },
+)
+print(generated.xml, generated.meta.schematron_version)
+
+# Validate any document against authority-pinned rules.
+result = beliq.validate(generated.xml, format="auto")
+if not result.valid:
+    for issue in result.errors:
+        print(issue.rule_id, issue.message)
+```
+
+## Authentication
+
+Create an API key in the beliq dashboard under API Keys:
+
+```python
+Beliq(api_key="blq_...")                    # sends X-API-Key (default)
+Beliq(api_key="blq_...", auth="bearer")      # sends Authorization: Bearer
+Beliq(api_key="blq_...", base_url="https://staging.beliq.eu")
+```
+
+## Async
+
+`AsyncBeliq` mirrors the sync client with `await`:
+
+```python
+import asyncio
+from beliq import AsyncBeliq
+
+async def main():
+    async with AsyncBeliq(api_key="blq_...") as beliq:
+        result = await beliq.validate(open("invoice.xml", "rb").read(), format="auto")
+        print(result.valid)
+
+asyncio.run(main())
+```
+
+## API
+
+| Method | Endpoint | Input | Returns |
+|---|---|---|---|
+| `me()` | GET /v1/me | none | `AccountInfo` (no quota cost) |
+| `generate(...)` | POST /v1/generate | EN 16931 invoice dict | `GenerateResult` |
+| `validate(document, ...)` | POST /v1/validate | XML or PDF | `ValidationResult` |
+| `parse(document, ...)` | POST /v1/parse | XML or PDF | `ParseResult` |
+| `convert(document, ...)` | POST /v1/convert | XML or PDF | `ConvertResult` |
+
+`document` accepts a `str`, `bytes`, or `bytearray`. The content type is sniffed from the bytes (PDF vs XML) unless you pass `content_type=`. `generate` and `convert` return the raw document `content` (bytes) plus the response-header metadata (`schematron_version`, `pdf_kind`, `source_format`/`target_format`, `lost_elements`, `conversion_tools`); for an XML output, `generate` also decodes `xml`.
+
+JSON responses are Pydantic models. Any field not explicitly typed (such as the per-country authority versions on a validation result) is preserved and accessible. Errors raise `BeliqApiError` with a typed `.code`, HTTP `.status`, and any `.details`:
+
+```python
+from beliq import BeliqApiError
+
+try:
+    beliq.validate("not xml")
+except BeliqApiError as err:
+    print(err.code, err.status, err.message)
+```
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+ruff check src tests
+mypy
+pytest                                   # unit tests (no network)
+BELIQ_API_KEY=blq_xxx pytest tests/test_integration.py   # hits the live API; draws quota
+```
+
+`tests/test_spec_contract.py` reads the vendored `openapi.json` and fails if the error-code set or the core validate fields drift from the spec. Refresh the vendored spec with `python scripts/sync_spec.py`.
+
+## Publishing
+
+Released to PyPI as [`beliq`](https://pypi.org/project/beliq/). Releases run from `.github/workflows/release.yml` via PyPI Trusted Publishing (OIDC, with attestations): push a `v*.*.*` tag to publish. No token is stored in the repo.
+
+## License
+
+MIT

beliq-0.1.0/README.md

@@ -0,0 +1,120 @@
+# beliq
+
+Official Python SDK for the [beliq](https://beliq.eu) e-invoicing compliance API. Generate, validate, parse, and convert EN 16931 invoices (XRechnung, ZUGFeRD, Factur-X, Peppol BIS) against authority-pinned, nightly-drift-checked rules.
+
+beliq produces and checks the compliant document. Transmission (Peppol, PDP, KSeF, SDI), archiving, and tax-authority reporting stay with your access point.
+
+## Install
+
+```bash
+pip install beliq
+```
+
+Requires Python >= 3.10.
+
+## Quick start
+
+```python
+from beliq import Beliq
+
+beliq = Beliq(api_key="blq_...")
+
+# Account, plan, and quota context (no quota cost).
+account = beliq.me()
+
+# Generate an XRechnung document from an EN 16931 invoice.
+generated = beliq.generate(
+    standard="xrechnung",
+    verify=True,
+    invoice={
+        "number": "INV-2026-001",
+        "issueDate": "2026-01-15",
+        "currencyCode": "EUR",
+        "seller": {"name": "Seller GmbH", "address": {"city": "Berlin", "postalCode": "10115", "countryCode": "DE"}},
+        "buyer": {"name": "Buyer GmbH", "address": {"city": "Munich", "postalCode": "80331", "countryCode": "DE"}},
+        "lines": [
+            {"description": "Consulting", "quantity": 10, "unitCode": "HUR", "unitPrice": 100, "lineTotal": 1000, "vatRate": 19, "vatCategoryCode": "S"}
+        ],
+        "totalNetAmount": 1000,
+        "totalTaxAmount": 190,
+        "totalGrossAmount": 1190,
+    },
+)
+print(generated.xml, generated.meta.schematron_version)
+
+# Validate any document against authority-pinned rules.
+result = beliq.validate(generated.xml, format="auto")
+if not result.valid:
+    for issue in result.errors:
+        print(issue.rule_id, issue.message)
+```
+
+## Authentication
+
+Create an API key in the beliq dashboard under API Keys:
+
+```python
+Beliq(api_key="blq_...")                    # sends X-API-Key (default)
+Beliq(api_key="blq_...", auth="bearer")      # sends Authorization: Bearer
+Beliq(api_key="blq_...", base_url="https://staging.beliq.eu")
+```
+
+## Async
+
+`AsyncBeliq` mirrors the sync client with `await`:
+
+```python
+import asyncio
+from beliq import AsyncBeliq
+
+async def main():
+    async with AsyncBeliq(api_key="blq_...") as beliq:
+        result = await beliq.validate(open("invoice.xml", "rb").read(), format="auto")
+        print(result.valid)
+
+asyncio.run(main())
+```
+
+## API
+
+| Method | Endpoint | Input | Returns |
+|---|---|---|---|
+| `me()` | GET /v1/me | none | `AccountInfo` (no quota cost) |
+| `generate(...)` | POST /v1/generate | EN 16931 invoice dict | `GenerateResult` |
+| `validate(document, ...)` | POST /v1/validate | XML or PDF | `ValidationResult` |
+| `parse(document, ...)` | POST /v1/parse | XML or PDF | `ParseResult` |
+| `convert(document, ...)` | POST /v1/convert | XML or PDF | `ConvertResult` |
+
+`document` accepts a `str`, `bytes`, or `bytearray`. The content type is sniffed from the bytes (PDF vs XML) unless you pass `content_type=`. `generate` and `convert` return the raw document `content` (bytes) plus the response-header metadata (`schematron_version`, `pdf_kind`, `source_format`/`target_format`, `lost_elements`, `conversion_tools`); for an XML output, `generate` also decodes `xml`.
+
+JSON responses are Pydantic models. Any field not explicitly typed (such as the per-country authority versions on a validation result) is preserved and accessible. Errors raise `BeliqApiError` with a typed `.code`, HTTP `.status`, and any `.details`:
+
+```python
+from beliq import BeliqApiError
+
+try:
+    beliq.validate("not xml")
+except BeliqApiError as err:
+    print(err.code, err.status, err.message)
+```
+
+## Development
+
+```bash
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+ruff check src tests
+mypy
+pytest                                   # unit tests (no network)
+BELIQ_API_KEY=blq_xxx pytest tests/test_integration.py   # hits the live API; draws quota
+```
+
+`tests/test_spec_contract.py` reads the vendored `openapi.json` and fails if the error-code set or the core validate fields drift from the spec. Refresh the vendored spec with `python scripts/sync_spec.py`.
+
+## Publishing
+
+Released to PyPI as [`beliq`](https://pypi.org/project/beliq/). Releases run from `.github/workflows/release.yml` via PyPI Trusted Publishing (OIDC, with attestations): push a `v*.*.*` tag to publish. No token is stored in the repo.
+
+## License
+
+MIT