Configuration for service (OpenAPI 3 or other) consumers
Project description
1 Welcome to ZGW Consumers’ documentation!
- Version:
0.33.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.10 or newer
Django 3.2 or newer
3.2 Install
Install from PyPI
pip install zgw-consumers
Add 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for zgw_consumers-0.33.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9f67fe8160511fb037afca7aa1fdfad7a8fd6333bb9491810ab2991f6784738b |
|
MD5 | 9b06435a0c65b567a57e9f030fd33505 |
|
BLAKE2b-256 | 3458ecdffb321388c71f4057bb9f1948fafc72ae22173f663d04b08131272643 |