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.9.dev1694849578.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1694849578.tar.gz
Algorithm Hash digest
SHA256 655464b41627ef8d55d68d22fab1568c7e65011f6187df8e185aae6426793059
MD5 2deffcaea271a2cdc1019ee6d73bdd78
BLAKE2b-256 df3e2bbf969e114faae56b1db108cab51d6268ed830a3e43dc8dc471fd2eb142

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.9.dev1694849578-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1694849578-py3-none-any.whl
Algorithm Hash digest
SHA256 dcf1e6ef6b2b76693f84e7c678000709c8e3d96cc9f6691cd6bd286e188bc8c0
MD5 10bf4b61d79229389b0a09ede25a2c63
BLAKE2b-256 77e8a925867c84bc8beec79e982634766acd56095f81e32788b038abccfb2e89

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