==========================================
VNG-API-common - Tooling voor RESTful APIs
==========================================
|build-status| |code-quality| |coverage| |docs| |black|
|python-versions| |django-versions| |pypi-version|
VNG-API-common biedt generieke implementaties en tooling voor RESTful APIs
in een Common Ground gegevenslandschap.
De tooling wordt o.a. gebruikt in de referentie-implementaties van componenten
voor zaakgericht werken, maar ook in VNG-APIs voor referentielijsten en de
Gemeentelijke Selectielijst.
Zie de uitgebreide `documentatie`_ voor de features en het gebruik.
.. contents::
.. section-numbering::
Features
========
* Centraal beheer van constanten die de verschillende componenten overstijgen
* GeoJSON OpenAPI definities
* Support voor Geo CRS negotation
* Ingebouwde support voor nested viewsets met declaratievere syntax voor
registratie
* Vaak voorkomende validators:
* RSIN/BSN validator
* Numerieke waarde validator
* Niet-negatieve waarde validator
* Alfanumerieke waarde (zonder diacritics)
* URL-validator (test dat URL bestaat) met pluggable link-checker
* ``UntilNowValidator`` - valideer datetimes tot en met *nu*.
* ``UniekeIdentificatieValidator`` (in combinatie met organisatie)
* ``InformatieObjectUniqueValidator`` om te valideren dat M2M entries
slechts eenmalig voorkomen
* ``ObjectInformatieObjectValidator`` om te valideren dat de synchronisatie
van een object-informatieobject relatie pas kan nadat deze relatie in het
DRC gemaakt is
* ``IsImmutableValidator`` - valideer dat bepaalde velden niet gewijzigd
worden bij een (partial) update, maar wel mogen gezet worden bij een create
* ``ResourceValidator`` - valideer dat een URL een bepaalde resource ontsluit
* Custom inspectors voor drf-yasg:
* Support voor ``rest_framework_gis`` ``GeometryField``
* SUpport voor ``django-extra-fields`` ``Base64FieldMixin``
* URL-based related resource filtering (``django-filter`` support)
* verzameling van mogelijke error-responses per operation
* Management command ``generate_swagger`` overloaded
* neemt default versie mee en maakt server-informatie domein-agnostisch
* optie om informatiemodel-resources naar markdown te renderen met backlinks
naar gemmaonline.nl
* Support voor ISO 8601 durations
* Custom model fields:
* ``RSINField``
* ``BSNField``
* ``LanguageField``
* ``VertrouwelijkheidsAanduidingField``
* ``DaysDurationField``
* Mocks voor de validators die netwerk IO hebben, eenvoudig via
``@override_settings`` toe te passen
* Test utilities
* Optionele notificaties applicatie:
* ontvangen van webhook events
* configureren en registreren van notificatiecomponent/webhooks
.. |build-status| image:: https://github.com/VNG-Realisatie/vng-api-common/workflows/ci-build/badge.svg
:alt: Build status
:target: https://github.com/VNG-Realisatie/vng-api-common/actions?query=workflow%3A%22ci-build%22
.. |code-quality| image:: https://github.com/VNG-Realisatie/vng-api-common/workflows/Code%20quality%20checks/badge.svg
:alt: Code quality checks
:target: https://github.com/VNG-Realisatie/vng-api-common/actions?query=workflow%3A%22Code+quality+checks%22
.. |coverage| image:: https://codecov.io/gh/VNG-Realisatie/vng-api-common/branch/master/graph/badge.svg
:target: https://codecov.io/gh/VNG-Realisatie/vng-api-common
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/vng-api-common/badge/?version=latest
:target: https://vng-api-common.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/vng-api-common.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/vng-api-common.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/vng-api-common.svg
:target: https://pypi.org/project/vng-api-common/
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. _documentatie: https://vng-api-common.readthedocs.io/en/latest/?badge=latest
Raw data
{
"_id": null,
"home_page": "https://github.com/VNG-Realisatie/vng-api-common",
"name": "vng-api-common",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "openapi,swagger,django,vng",
"author": "Maykin Media, VNG-Realisatie",
"author_email": "support@maykinmedia.nl",
"download_url": "https://files.pythonhosted.org/packages/76/99/792f785af8cd4c818bcfbf86712d84046d3083972926ec7bf2424d6bac71/vng-api-common-2.0.5.tar.gz",
"platform": null,
"description": "==========================================\nVNG-API-common - Tooling voor RESTful APIs\n==========================================\n\n|build-status| |code-quality| |coverage| |docs| |black|\n\n|python-versions| |django-versions| |pypi-version|\n\nVNG-API-common biedt generieke implementaties en tooling voor RESTful APIs\nin een Common Ground gegevenslandschap.\n\nDe tooling wordt o.a. gebruikt in de referentie-implementaties van componenten\nvoor zaakgericht werken, maar ook in VNG-APIs voor referentielijsten en de\nGemeentelijke Selectielijst.\n\nZie de uitgebreide `documentatie`_ voor de features en het gebruik.\n\n.. contents::\n\n.. section-numbering::\n\nFeatures\n========\n\n* Centraal beheer van constanten die de verschillende componenten overstijgen\n* GeoJSON OpenAPI definities\n* Support voor Geo CRS negotation\n* Ingebouwde support voor nested viewsets met declaratievere syntax voor\n registratie\n* Vaak voorkomende validators:\n * RSIN/BSN validator\n * Numerieke waarde validator\n * Niet-negatieve waarde validator\n * Alfanumerieke waarde (zonder diacritics)\n * URL-validator (test dat URL bestaat) met pluggable link-checker\n * ``UntilNowValidator`` - valideer datetimes tot en met *nu*.\n * ``UniekeIdentificatieValidator`` (in combinatie met organisatie)\n * ``InformatieObjectUniqueValidator`` om te valideren dat M2M entries\n slechts eenmalig voorkomen\n * ``ObjectInformatieObjectValidator`` om te valideren dat de synchronisatie\n van een object-informatieobject relatie pas kan nadat deze relatie in het\n DRC gemaakt is\n * ``IsImmutableValidator`` - valideer dat bepaalde velden niet gewijzigd\n worden bij een (partial) update, maar wel mogen gezet worden bij een create\n * ``ResourceValidator`` - valideer dat een URL een bepaalde resource ontsluit\n* Custom inspectors voor drf-yasg:\n * Support voor ``rest_framework_gis`` ``GeometryField``\n * SUpport voor ``django-extra-fields`` ``Base64FieldMixin``\n * URL-based related resource filtering (``django-filter`` support)\n * verzameling van mogelijke error-responses per operation\n* Management command ``generate_swagger`` overloaded\n * neemt default versie mee en maakt server-informatie domein-agnostisch\n * optie om informatiemodel-resources naar markdown te renderen met backlinks\n naar gemmaonline.nl\n* Support voor ISO 8601 durations\n* Custom model fields:\n * ``RSINField``\n * ``BSNField``\n * ``LanguageField``\n * ``VertrouwelijkheidsAanduidingField``\n * ``DaysDurationField``\n* Mocks voor de validators die netwerk IO hebben, eenvoudig via\n ``@override_settings`` toe te passen\n* Test utilities\n* Optionele notificaties applicatie:\n * ontvangen van webhook events\n * configureren en registreren van notificatiecomponent/webhooks\n\n.. |build-status| image:: https://github.com/VNG-Realisatie/vng-api-common/workflows/ci-build/badge.svg\n :alt: Build status\n :target: https://github.com/VNG-Realisatie/vng-api-common/actions?query=workflow%3A%22ci-build%22\n\n.. |code-quality| image:: https://github.com/VNG-Realisatie/vng-api-common/workflows/Code%20quality%20checks/badge.svg\n :alt: Code quality checks\n :target: https://github.com/VNG-Realisatie/vng-api-common/actions?query=workflow%3A%22Code+quality+checks%22\n\n.. |coverage| image:: https://codecov.io/gh/VNG-Realisatie/vng-api-common/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/VNG-Realisatie/vng-api-common\n :alt: Coverage status\n\n.. |docs| image:: https://readthedocs.org/projects/vng-api-common/badge/?version=latest\n :target: https://vng-api-common.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/vng-api-common.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/vng-api-common.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/vng-api-common.svg\n :target: https://pypi.org/project/vng-api-common/\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. _documentatie: https://vng-api-common.readthedocs.io/en/latest/?badge=latest\n",
"bugtrack_url": null,
"license": "EUPL 1.2",
"summary": "VNG API tooling",
"version": "2.0.5",
"project_urls": {
"Homepage": "https://github.com/VNG-Realisatie/vng-api-common"
},
"split_keywords": [
"openapi",
"swagger",
"django",
"vng"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a407a2180086502aa7e8b729a48165e15f64b7cb261669499d094cbc238f450",
"md5": "267637987ab1dc85976e417bc3c8254d",
"sha256": "c61a90368b5ee6c63673682bdd2a66c0ca0188fccc34480b189fa4a36cf58b40"
},
"downloads": -1,
"filename": "vng_api_common-2.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "267637987ab1dc85976e417bc3c8254d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2314854,
"upload_time": "2023-06-20T11:23:29",
"upload_time_iso_8601": "2023-06-20T11:23:29.086881Z",
"url": "https://files.pythonhosted.org/packages/1a/40/7a2180086502aa7e8b729a48165e15f64b7cb261669499d094cbc238f450/vng_api_common-2.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7699792f785af8cd4c818bcfbf86712d84046d3083972926ec7bf2424d6bac71",
"md5": "d0c505b63bd05b19e95232740b40ebd1",
"sha256": "ce7e77f51bccde533d1f724fa73652ca86857cafd801eb91baca335a1070ede6"
},
"downloads": -1,
"filename": "vng-api-common-2.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d0c505b63bd05b19e95232740b40ebd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2246980,
"upload_time": "2023-06-20T11:23:31",
"upload_time_iso_8601": "2023-06-20T11:23:31.054903Z",
"url": "https://files.pythonhosted.org/packages/76/99/792f785af8cd4c818bcfbf86712d84046d3083972926ec7bf2424d6bac71/vng-api-common-2.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-20 11:23:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VNG-Realisatie",
"github_project": "vng-api-common",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "vng-api-common"
}
JSON
