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

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-1.2.1.dev1757316968.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757316968.tar.gz
Algorithm Hash digest
SHA256 642bf05caec28af03984442b58c59a68f0c8ffa7638cd7d29578e595ee79770e
MD5 7ae3fa36426be96c3010381aa4c22ef7
BLAKE2b-256 928a21ff564a1dfc30a099c2404c32ba30e88b83c6ffb5c207ab465e1dd7271a

See more details on using hashes here.

File details

Details for the file openapi_python_generator-1.2.1.dev1757316968-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757316968-py3-none-any.whl
Algorithm Hash digest
SHA256 ea0712988a42152fcbcc897d78e7fb8a8dadcf73dea12a166daaccc1f4b045bc
MD5 c26101cd556f8cf1b0a94f19e25e5eea
BLAKE2b-256 7327a4b40c6744ef4e655edd70fc3e8cfe602de6a737ef07ee14fe88ed4c6081

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