Skip to main content

TypedDict typings for OpenAPI specification

Project description

OpenAPI typed

Python typings for OpenAPI using TypedDict.

Installation

Install package from PyPI.

pip install openapi-typed

Usage

from openapi_typed import OpenAPIObject, Info

# Valid OpenAPIObject
openapi_valid = OpenAPIObject(
    openapi="3.0.0",
    info=Info(
        title="My API",
        version="0.0.0")
    )

# Invalid OpenAPIObject
openapi_invalid = OpenAPIObject(
    openap="3.0.0",  # Type-check error, unknown attribute
    info=Info(
        title="My API"  # Type-check error, missing attribute `version`
    )
)

Development

Install development dependencies:

pip install -e .[dev]

Run tests:

pytest
# OR
python setup.py test

Build package:

python setup.py dist

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for openapi-typed, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size openapi_typed-0.0.1-py2.py3-none-any.whl (4.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size openapi_typed-0.0.1.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page