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.dev1757316547.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757316547.tar.gz
Algorithm Hash digest
SHA256 f242ecb607374d11c77b6813d2e057a125d5bb4bca62433f3d7892b2da60e7b5
MD5 bfe4a0e02ee3732ab7f95c30543d6099
BLAKE2b-256 2c46345d0682b79e8f50d1907f27dc1b4cc0a2b85489d67ca529fdb1b57fedbc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757316547-py3-none-any.whl
Algorithm Hash digest
SHA256 fc3d9789efbb0e469cae9cce86fc14a0a83d34b93b5dc3001b2a6520921edff4
MD5 c3e4ab7efe1537f06794eb4dc3b48826
BLAKE2b-256 fe0feebd88a5849516a8f1873bbe96f06d9c96fd24a6e3f00efb1ba2b8eb7bd8

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