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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.7.dev1688499481.tar.gz
Algorithm Hash digest
SHA256 03798ead9933155934d2320a1134d4b3449b4b24db39f52ed4d6387ca9a348df
MD5 8cac381a517f4ad6457f9c13f7ae6aa4
BLAKE2b-256 82cbbd4847ddc4abc78ffca00d6817e6e2b7a02de6681af2e0827bb273231011

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.7.dev1688499481-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.7.dev1688499481-py3-none-any.whl
Algorithm Hash digest
SHA256 53aaddb068b4c47246f7644a1be3851d8b0df40aca413c3ebbce364070d5aaa5
MD5 a4fb4c4e5f15e5f699ead8c618dc53de
BLAKE2b-256 5cf8b1b62ae8f37a9e1d1de2f3186eb525aee62bdf13eee29ad129f1adf1c345

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