Skip to main content

Configuration for service (OpenAPI 3 or other) consumers

Project description

1 Welcome to ZGW Consumers’ documentation!

Version:

0.38.1

Source:

https://github.com/maykinmedia/zgw-consumers

Keywords:

OpenAPI, Zaakgericht Werken, Common Ground, NLX

Run CI Coverage status Code linting Documentation Status

python-versions django-versions pypi-version

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 4.2 or newer

3.2 Install

  1. Install from PyPI

pip install zgw-consumers
  1. 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

zgw_consumers-0.38.1.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

zgw_consumers-0.38.1-py3-none-any.whl (67.2 kB view details)

Uploaded Python 3

File details

Details for the file zgw_consumers-0.38.1.tar.gz.

File metadata

  • Download URL: zgw_consumers-0.38.1.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for zgw_consumers-0.38.1.tar.gz
Algorithm Hash digest
SHA256 35b54f8634d9d054858c2777000ea29f51e06e0acdfa94d4241864b4d5c53eb6
MD5 15c0022a2e4ba06eac97158ad81d37e7
BLAKE2b-256 7ccedeaecb4e7bfa9d6d639cd1dfa0aa5970d19717d396b18e91413c6bbced70

See more details on using hashes here.

Provenance

The following attestation bundles were made for zgw_consumers-0.38.1.tar.gz:

Publisher: ci.yml on maykinmedia/zgw-consumers

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file zgw_consumers-0.38.1-py3-none-any.whl.

File metadata

  • Download URL: zgw_consumers-0.38.1-py3-none-any.whl
  • Upload date:
  • Size: 67.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for zgw_consumers-0.38.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0487d4786857d040c2ed0b5289aa26802f13ec8439d9526167379f5e605292b7
MD5 2b2f8fc9e58e2a6b2d8513cbe88c8d29
BLAKE2b-256 673cc932c8ee63a1133a91c50d63d1a88819955f823de18cd53d52321de0a896

See more details on using hashes here.

Provenance

The following attestation bundles were made for zgw_consumers-0.38.1-py3-none-any.whl:

Publisher: ci.yml on maykinmedia/zgw-consumers

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page