| Name | zgw-consumers-oas JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | Tooling to deal with OpenAPI specifications, extracted from zgw-consumers. |
| upload_time | 2024-03-29 09:59:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Copyright 2024 Maykin Media Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
zgw
common ground
vng
api
openapi
oas
mtls
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
ZGW Consumers' OAS tooling
==========================
:Version: 1.0.0
:Source: https://github.com/maykinmedia/zgw-consumers-oas
:Keywords: OpenAPI, Django, zgw-consumers
|build-status| |coverage| |linting|
|python-versions| |django-versions| |pypi-version|
Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.
.. contents::
.. section-numbering::
ZGW Consumers used to have a hard requirement on OpenAPI 3.0 specifications for its
services. On the way to 1.0, this requirement became obsolete, and it has no need
anymore for this kind of tooling.
However, we understand that upgrading to zgw-consumers 1.0 is quite a big breaking
change if you rely on this tooling, so it was decided to provide it in a standalone
package to ease the transition.
This package is considered "feature complete" and will only receive bugfixes. No new
features will be added.
Installation
============
Requirements
------------
* Python 3.10 or newer
* Django 3.2 or newer
Install
-------
1. Install from PyPI
.. code-block:: bash
pip install zgw-consumers-oas
Usage
=====
#. Update the relevant ``zgw_consumers.test.*`` imports to ``zgw_consumers_oas.*``
#. You can continue using the ``ZGW_CONSUMERS_*`` settings to discover OpenAPI schema
files.
.. |build-status| image:: https://github.com/maykinmedia/zgw-consumers-oas/workflows/Run%20CI/badge.svg
:target: https://github.com/maykinmedia/zgw-consumers-oas/actions?query=workflow%3A%22Run+CI%22
:alt: Run CI
.. |linting| image:: https://github.com/maykinmedia/zgw-consumers-oas/workflows/Code%20quality%20checks/badge.svg
:target: https://github.com/maykinmedia/zgw-consumers-oas/actions?query=workflow%3A%22Code+quality+checks%22
:alt: Code linting
.. |coverage| image:: https://codecov.io/gh/maykinmedia/zgw-consumers-oas/branch/main/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/zgw-consumers-oas
:alt: Coverage status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/zgw_consumers_oas.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/zgw_consumers_oas.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/zgw_consumers_oas.svg
:target: https://pypi.org/project/zgw_consumers_oas/
Raw data
{
"_id": null,
"home_page": null,
"name": "zgw-consumers-oas",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Django, ZGW, Common Ground, VNG, API, OpenAPI, OAS, mTLS",
"author": null,
"author_email": "Maykin Media <support@maykinmedia.nl>",
"download_url": "https://files.pythonhosted.org/packages/ca/06/33ab88b994317165fd2e6d11b1e32b43925079a50d66b221465c80ee751a/zgw-consumers-oas-1.0.0.tar.gz",
"platform": null,
"description": "ZGW Consumers' OAS tooling\n==========================\n\n:Version: 1.0.0\n:Source: https://github.com/maykinmedia/zgw-consumers-oas\n:Keywords: OpenAPI, Django, zgw-consumers\n\n|build-status| |coverage| |linting|\n\n|python-versions| |django-versions| |pypi-version|\n\nTooling to deal with OpenAPI specifications, extracted from zgw-consumers.\n\n.. contents::\n\n.. section-numbering::\n\nZGW Consumers used to have a hard requirement on OpenAPI 3.0 specifications for its\nservices. On the way to 1.0, this requirement became obsolete, and it has no need\nanymore for this kind of tooling.\n\nHowever, we understand that upgrading to zgw-consumers 1.0 is quite a big breaking\nchange if you rely on this tooling, so it was decided to provide it in a standalone\npackage to ease the transition.\n\nThis package is considered \"feature complete\" and will only receive bugfixes. No new\nfeatures will be added.\n\n\nInstallation\n============\n\nRequirements\n------------\n\n* Python 3.10 or newer\n* Django 3.2 or newer\n\n\nInstall\n-------\n\n1. Install from PyPI\n\n.. code-block:: bash\n\n pip install zgw-consumers-oas\n\nUsage\n=====\n\n#. Update the relevant ``zgw_consumers.test.*`` imports to ``zgw_consumers_oas.*``\n\n#. You can continue using the ``ZGW_CONSUMERS_*`` settings to discover OpenAPI schema\n files.\n\n\n\n.. |build-status| image:: https://github.com/maykinmedia/zgw-consumers-oas/workflows/Run%20CI/badge.svg\n :target: https://github.com/maykinmedia/zgw-consumers-oas/actions?query=workflow%3A%22Run+CI%22\n :alt: Run CI\n\n.. |linting| image:: https://github.com/maykinmedia/zgw-consumers-oas/workflows/Code%20quality%20checks/badge.svg\n :target: https://github.com/maykinmedia/zgw-consumers-oas/actions?query=workflow%3A%22Code+quality+checks%22\n :alt: Code linting\n\n.. |coverage| image:: https://codecov.io/gh/maykinmedia/zgw-consumers-oas/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/zgw-consumers-oas\n :alt: Coverage status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/zgw_consumers_oas.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/zgw_consumers_oas.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/zgw_consumers_oas.svg\n :target: https://pypi.org/project/zgw_consumers_oas/\n",
"bugtrack_url": null,
"license": "Copyright 2024 Maykin Media Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/maykinmedia/zgw-consumers-oas/issues",
"Homepage": "https://github.com/maykinmedia/zgw-consumers-oas",
"Source Code": "https://github.com/maykinmedia/zgw-consumers-oas"
},
"split_keywords": [
"django",
" zgw",
" common ground",
" vng",
" api",
" openapi",
" oas",
" mtls"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "542d51aea09b5c70d1755e3c47a24876b10589d47551fd1654921e5c118b93fc",
"md5": "58547028615083904c346e5425d4ce70",
"sha256": "869dc0ddfa414209ed24ea52b5aaa6c80e151e6a451393804cce9716ac8ef3d8"
},
"downloads": -1,
"filename": "zgw_consumers_oas-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58547028615083904c346e5425d4ce70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6470,
"upload_time": "2024-03-29T09:59:09",
"upload_time_iso_8601": "2024-03-29T09:59:09.988585Z",
"url": "https://files.pythonhosted.org/packages/54/2d/51aea09b5c70d1755e3c47a24876b10589d47551fd1654921e5c118b93fc/zgw_consumers_oas-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca0633ab88b994317165fd2e6d11b1e32b43925079a50d66b221465c80ee751a",
"md5": "451aa010b18fe6e84d76647bf093dec6",
"sha256": "6ab9ecc0e0aa1608b61f3fc2f7e6d33a97bda383e9c0a0c1a9dc545b23ae4f57"
},
"downloads": -1,
"filename": "zgw-consumers-oas-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "451aa010b18fe6e84d76647bf093dec6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 7921,
"upload_time": "2024-03-29T09:59:11",
"upload_time_iso_8601": "2024-03-29T09:59:11.905672Z",
"url": "https://files.pythonhosted.org/packages/ca/06/33ab88b994317165fd2e6d11b1e32b43925079a50d66b221465c80ee751a/zgw-consumers-oas-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 09:59:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "zgw-consumers-oas",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "zgw-consumers-oas"
}
