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.4.4.dev1686929586.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.4.dev1686929586.tar.gz
Algorithm Hash digest
SHA256 fadd690c72552988e56372eb123b200ac5addd6bd5046705d76a09bf592de18e
MD5 2934209e9aa5e173d3adfbd9643f7a07
BLAKE2b-256 6dbb065b8c0346806d8bf3d26c8b7a0bcd1c2ba00e6d05fec36a95ba01a597f7

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.4.dev1686929586-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.4.dev1686929586-py3-none-any.whl
Algorithm Hash digest
SHA256 432f226e48aeb98698a691e7e35d47620d243e5b98bafefe2f7ba32de8a2230a
MD5 432223104360d0f0ae6fae756a3da2c9
BLAKE2b-256 6e9e888f991dca9a1e1a0078e8389c1492c520e7e32e36ed4d5d2fa136d2bf93

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