Skip to main content

TypedDict typings for OpenAPI specification

Project description

OpenAPI typed

CircleCI PyPI PyPi License

Python typings for OpenAPI using dataclass.

Installation

Install package from PyPI.

pip install openapi-typed-2

Usage

from openapi_typed_2 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

Run type-checks with mypy:

mypy openapi_typed

Build package:

python setup.py dist

Contributing

Thanks for wanting to contribute! We will soon have a contributing page detaling how to contribute. Meanwhile, feel free to star this repository, open issues and ask for more features and support.

Please note that this project is governed by the Meeshkan Community Code of Conduct. By participating in this project, you agree to abide by its terms.

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-2, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size openapi_typed_2-0.0.4-py2.py3-none-any.whl (15.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size openapi_typed_2-0.0.4.tar.gz (15.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page