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.5.1.dev1706184178.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.5.1.dev1706184178.tar.gz
Algorithm Hash digest
SHA256 56628e54af24ea7076cfd414655f56834086ce168e789a91978728b1b244955c
MD5 2a58e33546a29fd4ab0a713f9ebd8877
BLAKE2b-256 65d8f9ca0721889b3d55697bd7f087044a0fe6229d1d9b9e46d1e73608259b45

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.5.1.dev1706184178-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.5.1.dev1706184178-py3-none-any.whl
Algorithm Hash digest
SHA256 e8d2ca3804275275c75813636824e80e5dcb46e86cc3fd8fb540b4c56c11e7b7
MD5 7f73a780c9d8095aab37cc11992d2d56
BLAKE2b-256 bd627d12956c7f66cedd8d608edda382f013395512e38386605dfa856830400f

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