Metadata-Version: 2.1
Name: gemma-zds-client
Version: 2.0.0
Summary: Generieke client voor GEMMA-zaken componenten
Home-page: https://github.com/VNG-Realisatie/gemma-zds-client
Author: Maykin Media, VNG-Realisatie
Author-email: support@maykinmedia.nl
License: EUPL 1.2
Keywords: openapi,swagger,django,vng,client,requests
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Provides-Extra: tests
Provides-Extra: pep8
Provides-Extra: coverage
Provides-Extra: docs
Provides-Extra: release

=============================================
ZDS-Client - Generic Common Ground API Client
=============================================

|build-status| |coverage| |docs| |pypi-version|

|linting| |black| |python-versions|

The Common Ground API Client is a generic client for Common Ground APIs built with
OpenAPI 3.0 specifications.

.. contents::

.. section-numbering::

Features
========

* Driven by OAS 3.0 specification
* (Pluggable) caching of api specifications
* Create/mutate resources according to the api specifications
* Support for multiple authentication schemes

    * ZGW auth (JWT based)
    * API-key via HTTP headers
    * or none, for open APIs

* Generic approach with some builtins for the "Zaakgericht Werken API's" standard
* Built on top of battle-proven `requests`_ library.

Installation and usage
======================

See the `documentation <https://gemma-zds-client.readthedocs.io/en/latest/?badge=latest>`_

.. _requests: https://pypi.org/project/requests/

.. |build-status| image:: https://github.com/maykinmedia/gemma-zds-client/workflows/Run%20CI/badge.svg
    :alt: Build status
    :target: https://github.com/maykinmedia/gemma-zds-client/actions?query=workflow%3A%22Run+CI%22

.. |coverage| image:: https://codecov.io/gh/maykinmedia/gemma-zds-client/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/maykinmedia/gemma-zds-client
    :alt: Coverage status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |docs| image:: https://readthedocs.org/projects/gemma-zds-client/badge/?version=latest
   :alt: Documentation Status
   :target: https://gemma-zds-client.readthedocs.io/en/latest/?badge=latest

.. |linting| image:: https://github.com/maykinmedia/gemma-zds-client/actions/workflows/code_quality.yml/badge.svg
   :alt: Code quality checks
   :target: https://github.com/maykinmedia/gemma-zds-client/actions/workflows/code_quality.yml

.. |python-versions| image:: https://img.shields.io/pypi/pyversions/gemma-zds-client.svg

.. |pypi-version| image:: https://img.shields.io/pypi/v/gemma-zds-client.svg
    :target: https://pypi.org/project/gemma-zds-client/
