Reusable code for consumers of ZGW APIs
Project description
1 Welcome to ZGW Consumers’ documentation!
- Version:
0.12.2
- Source:
- Keywords:
OpenAPI, Zaakgericht Werken, Common Ground, NLX
- PythonVersion:
3.6, 3.7, 3.8
Manage your external API’s to consume.
2 Features
Store services with their configuration in the database
Integrate with OpenAPI 3.0 specifications
NLX support
Declare data/domain objects as modern Python dataclasses
3 Installation
3.1 Requirements
Python 3.6 or newer
setuptools 30.3.0 or newer
Django 2.2 or newer
3.2 Install
Install from PyPI
pip install zgw-consumersAdd zgw_consumers to the INSTALLED_APPS setting.
Optionally override ZGW_CONSUMERS_CLIENT_CLASS to a custom client class.
Optionally specify ZGW_CONSUMERS_OAS_CACHE to point to a separate django cache. Defaults to django.core.cache.DEFAULT_CACHE_ALIAS, which is default in practice. For performance reasons we highly recommend to use a real cache backend like Redis or Memcache.
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.models import Service
client = Service.get_client(some_url)Or, to just retrieve the auth header(s):
from zgw_consumers.models import Service
auth = Service.get_auth_header(some_url)Data model
Use zgw_consumers.api_models.base.factory to turn raw JSON responses into instances of domain models:
from zgw_consumers.api_models.base import factory
from zgw_consumers.api_models.zaken import Zaak
results = client.list("zaak")["results"]
return factory(Zaak, results)It works for both collections and scalar values, and takes care of the camel-case to snake case conversion.
You can also define your own data models, take a look at the zgw_consumers.api_models package for inspiration.
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
File details
Details for the file zgw-consumers-0.12.2.tar.gz.
File metadata
- Download URL: zgw-consumers-0.12.2.tar.gz
- Upload date:
- Size: 21.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a154c1d65343a1629f192ece626a0daa0a8531d8ac26eca90c29fbc296a09bf7 |
|
| MD5 | 36115710926dba25c5885865f357ee90 |
|
| BLAKE2b-256 | 3b265726e6191bcda98d5de8fb0da0b15cedcd32136edfccf436328d24aa864d |
File details
Details for the file zgw_consumers-0.12.2-py3-none-any.whl.
File metadata
- Download URL: zgw_consumers-0.12.2-py3-none-any.whl
- Upload date:
- Size: 30.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d4f01863b81caf6f93aabcd46d34319a7d96cc3fac258fb2f20ac0dfbadf9311 |
|
| MD5 | 6d292c9bdfab6078edfea6a81227e440 |
|
| BLAKE2b-256 | c3760816b5833a505322bb257bcd91a2b808106e7844683caf09eb0620ec5c93 |
