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.8.dev1692255289.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.8.dev1692255289.tar.gz
Algorithm Hash digest
SHA256 7eac3ef98f2d195ce7668a24d061cf48ecc618fad841d571dd393b7cac8c1efb
MD5 819ed954abda7f26fa415dd86daeacb3
BLAKE2b-256 28cee7caa65dc9562da2e17a3f3b5fa926bcbd4a69ce41654558e4410e8db736

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.8.dev1692255289-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.8.dev1692255289-py3-none-any.whl
Algorithm Hash digest
SHA256 8df7100ba25d30b34e8a70fc7fe0dea40cefbd49999227576e8903b9c6633369
MD5 8e8fdcc5e9d86b328fce91e7023abfd8
BLAKE2b-256 36a284f32f9502d953a382f9a9cf9dfcdf31b41fc961ec55702c1e69c488f27d

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