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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1706184054.tar.gz
Algorithm Hash digest
SHA256 3515d49fdfbcb3673f6c75c2a9566656db4b05508bb038e05877a7fb8e22801c
MD5 b1002aafda928b5f681b6a1c3cf9a0eb
BLAKE2b-256 a7cca8252b239c872f67fbe80fcdb054c71dff4ec95e2a331877ad4ee0c9e839

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1706184054-py3-none-any.whl
Algorithm Hash digest
SHA256 b0e996237d6caaf8d67ef4780e84f064b5ab4edd98dfa9ade69f3eef20a4910b
MD5 5d849dc4a66207faabbedb1759d324d0
BLAKE2b-256 adcacdbf29274915feaf96de97c781c54b72ef4308037eb355f9ecaeaeec21d6

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