1 Welcome to ZGW Consumers’ documentation!
- Version:
2.1.0
- Source:
- Keywords:
OpenAPI, Zaakgericht Werken, Common Ground, NLX
Manage your external API’s to consume.
2 Features
Store services with their configuration in the database
Built in ape-pie API client adapter
NLX support
Declare data/domain objects as modern Python dataclasses
3 Installation
3.1 Requirements
Python 3.12 or newer
Django 5.2 or newer
3.2 Install
Install from PyPI
pip install zgw-consumersAdd zgw_consumers and simple_certmanager to the INSTALLED_APPS setting.
4 Usage
In the Django admin, you can create Service instances to define your external APIs.
Client
To get a client for a given resource, you can use:
from zgw_consumers.client import build_client
from zgw_consumers.models import Service
my_service = Service.objects.get(api_root="https://api.example.com/")
client = build_client(my_service)
with client:
# The preferred way to use the client is within a context manager
client.get("relative/url")The resulting client will have certificate and authentication automatically configured from the database configuration.
2 maintainers
Metadata
2 maintainers
Release files for zgw-consumers 2.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| zgw_consumers-2.1.0.tar.gz | 57.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| zgw_consumers-2.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 124.3 kB
Release files / zgw_consumers-2.1.0.tar.gz
| Download URL | zgw_consumers-2.1.0.tar.gz |
|---|---|
| Size | 57.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a9d83d56c83d28e3a5fefa970ebaa17d9d2628e03a8170016c055d01c3f342b0
|
|
BLAKE2b-256 checksum How to use checksums |
953715fe6d4cd940c184490a99d79f5dfd5d8946cdc79979a81e41ad40e65d13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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 2, 2026.
Transparency logRelease files / zgw_consumers-2.1.0-py3-none-any.whl
| Download URL | zgw_consumers-2.1.0-py3-none-any.whl |
|---|---|
| Size | 66.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cbd0a9098470a72c53415e882360ee8ebc5e964d3b62a6e11e50282dd079522c
|
|
BLAKE2b-256 checksum How to use checksums |
2921422b58ce909f29784d150a38851a2e75146a107e5bce38d13e7557b4785c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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 2, 2026.
Transparency log
