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-1.0.1.dev1732809362.tar.gz (17.2 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-1.0.1.dev1732809362.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.0.1.dev1732809362.tar.gz
Algorithm Hash digest
SHA256 f219d8b5ec043d0b34fd21ecbacfce7f7154c0e61cf867a5d4ddc52a7157a9dd
MD5 3426c9e8b7ca74577e62e033d516a49a
BLAKE2b-256 53cb3a1b6f5faef8f26360b9d37271b8874053261af7fd63db3f52d3e9713259

See more details on using hashes here.

File details

Details for the file openapi_python_generator-1.0.1.dev1732809362-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-1.0.1.dev1732809362-py3-none-any.whl
Algorithm Hash digest
SHA256 89c5be23d443c6be332fd8794e12c17e1daecc078087bef18df038418ade9dbe
MD5 a30cc66bfae4275b9b6a4d8e3514f340
BLAKE2b-256 77115b09e2d47d460d182f0e09643803b63bcc1f39dda2130175bff084c30785

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