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

File metadata

File hashes

Hashes for openapi-python-generator-0.4.3.dev1677756840.tar.gz
Algorithm Hash digest
SHA256 2c7235792dc543014cf23d00def644304bdabee5e93b9376a2f5c396f7f81b02
MD5 5a2ac6d8162d2c68ed8346597297b33d
BLAKE2b-256 7fe34cadd7a8b17b363a6d0e1f0bf3e143f9f60d6733779a4c09cf298b46b600

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.3.dev1677756840-py3-none-any.whl
Algorithm Hash digest
SHA256 9fff9def6320f604d40b4c98e8ba800fb270ec7cb0334f1514ff558f62feb746
MD5 092c3629bc9fd314e8f9daa90135fd30
BLAKE2b-256 0126c52caf9a519f11e860b10487987a5643a5c7f808cf22208df79cec659418

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