Skip to main content

Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.

Project description

1 ZGW Consumers’ OAS tooling

Version:

1.0.0

Source:

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

Keywords:

OpenAPI, Django, zgw-consumers

Run CI Coverage status Code linting

python-versions django-versions pypi-version

Tooling to deal with OpenAPI specifications, extracted from zgw-consumers.

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.

2 Installation

2.1 Requirements

  • Python 3.10 or newer

  • Django 3.2 or newer

2.2 Install

  1. Install from PyPI

pip install zgw-consumers-oas

3 Usage

  1. Update the relevant zgw_consumers.test.* imports to zgw_consumers_oas.*

  2. You can continue using the ZGW_CONSUMERS_* settings to discover OpenAPI schema files.

Project details


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-oas-1.0.0.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

zgw_consumers_oas-1.0.0-py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 3

Supported by

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