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.
Source Distribution
openapi_typed-0.0.1.tar.gz
(6.1 kB
view hashes)
Built Distribution
Close
Hashes for openapi_typed-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d4f0d69cf43ba9fb650ed67c55c192da62256e1ca5596b02400af3c9ad56ce5 |
|
MD5 | 4d96ed8839201fa636174efc3b319909 |
|
BLAKE2b-256 | 2a0b8deacf182b5d9d308c1c40c786c37a60cfb06b736add6d2d51db511848a1 |