Skip to main content

TypedDict typings for OpenAPI specification

Project description

OpenAPI typed

github PyPI PyPi License

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

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.

Source Distribution

openapi_typed-0.1.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

openapi_typed-0.1.0-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file openapi_typed-0.1.0.tar.gz.

File metadata

  • Download URL: openapi_typed-0.1.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.2

File hashes

Hashes for openapi_typed-0.1.0.tar.gz
Algorithm Hash digest
SHA256 686d133a4ce148f921b0ef3eb26d507f2ff9750d0bbfd536155466ac06913c7e
MD5 c19bc434c12acced63161e82d8b12ead
BLAKE2b-256 c44de1857d0c7881bacc0c4fdae2e6e7cb5ab49065d7eb0b8fc83f3c81a432a9

See more details on using hashes here.

File details

Details for the file openapi_typed-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: openapi_typed-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.2

File hashes

Hashes for openapi_typed-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a3d4674ff3229d6428acb07cd572ad2d51104943d73adfeee9238fd70cd73524
MD5 080a1f2925e9a9cd0885694589c4b942
BLAKE2b-256 88c3dc2d1ad18676f158906a5753bd1a6c595c1e095096ee9fbff19470649282

See more details on using hashes here.

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