Skip to main content

Openapi Python Generator

Project description

Openapi Python Generator

PyPI Status Python Version License

Read the documentation at https://openapi-python-generator.readthedocs.io/ Tests Codecov

pre-commit Black

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

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.2.4.dev1656406587.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.4.dev1656406587.tar.gz
Algorithm Hash digest
SHA256 ad608850947ab566bc0f79eecfba25d48bcdaa118bb971a7fa5fb377ecc43ce9
MD5 03357e83a6b8b4a501a575744455fb7a
BLAKE2b-256 93d1407d82cf66a22131272adc58825af689fa124750e5567be890655e288066

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.4.dev1656406587-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.4.dev1656406587-py3-none-any.whl
Algorithm Hash digest
SHA256 131f516621a8a82d6a987593abe440a200774e6ccc8aa9c873a099636fe9f8e4
MD5 bede24bb88f19ee87e141b8a9f1a590b
BLAKE2b-256 1a4849cb80ee5909da932dc83a12e99e99d97d0aee34234efdb3baecbda9a605

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