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.1.dev1677063922.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.1.dev1677063922.tar.gz
Algorithm Hash digest
SHA256 71333bc347c37faa7fbd0283d4f8fa361778845ee17a685e12bcae74d9b18e01
MD5 fa591e5600d8fbf89b098da8e46bb308
BLAKE2b-256 d6e43417bd3d8ab462e26bcff514648eb54b6eeb83a8500ec73185236e0dc9c6

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.1.dev1677063922-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.1.dev1677063922-py3-none-any.whl
Algorithm Hash digest
SHA256 f66d0977c62d74022740f1932aaad0bc4d1ace763a70f48dcc0e08cbaad0afad
MD5 fba7b5ddca5fbff7ef69d1b79dc096ec
BLAKE2b-256 45653728e71a3226c6978b8b953896c90deedb476df481a645198f8f5c20acf6

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