Skip to main content

Openapi Python Generator

Project description

Openapi Python Generator

PyPI Status Python Version License

Tests Codecov

pre-commit Black


Documentation: here


Features

  • Ease of use. Provide input, output and the library, and the generator will do the rest.
  • Type safety and type hinting. OpenAPI python generator makes heavy use of pydantic models to provide type-safe data structures.
  • Support for multiple rest frameworks. OpenAPI python generator currently supports the following:
  • Async and sync code generation support, depending on the framework. It will automatically create both for frameworks that support both.
  • Easily extendable using Jinja2 templates. The code is designed to be easily extendable and should support even more languages and frameworks in the future.
  • Fully tested. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.
  • Usage as CLI or as library.

Requirements

  • Python 3.7+

Installation

You can install Openapi Python Generator via pip from PyPI:

$ pip install openapi-python-generator

Usage

Please see the Quick start page for details.

Roadmap

  • Support for all commonly used http libraries in the python ecosystem (requests, urllib, ...)
  • Support for multiple languages
  • Support for multiple authentication schemes
  • Support custom themes

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Openapi Python Generator is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

Special thanks to the peeps from openapi-schema-pydantic, which already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Built Distribution

File details

Details for the file openapi-python-generator-0.3.6.dev1671455259.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.6.dev1671455259.tar.gz
Algorithm Hash digest
SHA256 0a2c212244819897d37b1175386457f2b4763a6c6f8c34f2f38f10b152ec3a6e
MD5 f24d2c4cbf01cb6075f852c1035971a8
BLAKE2b-256 24757d77921984830c38869c463a99d28f9c6cf90a9526442cfd64afbc0c3d70

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.6.dev1671455259-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.6.dev1671455259-py3-none-any.whl
Algorithm Hash digest
SHA256 25f73d97a7a90df2b57e903361b4a3d2f1ff846fd157dfa4095a6fb26a376522
MD5 d1337fe00cdd9bc2c389aeb954db38d5
BLAKE2b-256 e17c9ee87025c80fdf8ecfda5b2e3be7508bbd5cf5acb5870b2185399af0b11c

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