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.9.dev1674563587.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.9.dev1674563587.tar.gz
Algorithm Hash digest
SHA256 d3f31cb5dfbf172f2448821cbceef9a04ed389dbc56a53754ee72952e1726ac8
MD5 5c549f050cdfe4c3e8f68cd35a142b93
BLAKE2b-256 2432970ff4a3719ff416e3616d44448fdfad7639d955cdfbb71e4293aff3f141

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.9.dev1674563587-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.9.dev1674563587-py3-none-any.whl
Algorithm Hash digest
SHA256 5704f64b4d33cba1f76114c88c1aa471f2d3a915c12f5cf00f48280a4708967a
MD5 149ebe64895a38061a08b33c18a4fa65
BLAKE2b-256 2c4fe7aac51dceac648d61472976f9856f03cd2133a2005dbed04f4ed2c0e417

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