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.4.3.dev1677756458.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.3.dev1677756458.tar.gz
Algorithm Hash digest
SHA256 c50d51d2888584ce9d395551935f4d44a4937bf551dacbe70c43a3c15fba8418
MD5 084f6e0fc754fe2e44ab503977373d9c
BLAKE2b-256 af42cce104ead90eb346299f51243cfc3dc066723e916da539d8ff5146d5bf7b

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.3.dev1677756458-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.3.dev1677756458-py3-none-any.whl
Algorithm Hash digest
SHA256 d3e8614de0f56675cfc2cbbb109c500d203a9a225e1ffe2c3d0f2b00ef570a73
MD5 070a7bdc3c9f020018fd885d4cb4e03c
BLAKE2b-256 93effb7de171b0951a5ff754b93b0837a866dfb244b104baa1271395d58613eb

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