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

openapi_python_generator-2.0.1.dev1758565728.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file openapi_python_generator-2.0.1.dev1758565728.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-2.0.1.dev1758565728.tar.gz
Algorithm Hash digest
SHA256 e7f529472d9c49c0aa1c757ad5eb1f9e8be212c19aabd22d8fa2a8616f75f87e
MD5 7f26cdaf170e3f4c4c6fae7c521d8699
BLAKE2b-256 9f38d9d222087bb353951e41ab1373fe06de0e8838148c11765e73bee2c1229c

See more details on using hashes here.

File details

Details for the file openapi_python_generator-2.0.1.dev1758565728-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-2.0.1.dev1758565728-py3-none-any.whl
Algorithm Hash digest
SHA256 4f491e25dc568d87a8c19a219076043edd47e7ff6159cbaa5a9994ff2826c464
MD5 3865fb07232451cff48f337ef25aa783
BLAKE2b-256 d3e78e8c35bb9bf5ae73cd20e077538efab152b49479e7bee325e19f67ab847e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page