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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1703230912.tar.gz
Algorithm Hash digest
SHA256 f360cdb87008de10a4d72297d6fc452f002182413a45055e822639c42f4ef333
MD5 a476ce4ec3d995d6470aba92ef7e3d64
BLAKE2b-256 6b848ffd427a3780a4cdbd4f9cd46c3c35fc89d1fe534e22c7b0e87edff70a3c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1703230912-py3-none-any.whl
Algorithm Hash digest
SHA256 98ccae8d8a6c6ebe4e88beb6596aff5ca53aef3858bb0ff3666d82ac6f4300e8
MD5 0f4c1747c587c952f0cbf33c6e3b8f34
BLAKE2b-256 e2cf2edab67c49e3b6d3ad25cdae85bf344524f40f91102d48590411400fe27f

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