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.2.dev1677168160.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.2.dev1677168160.tar.gz
Algorithm Hash digest
SHA256 61fe7b3685eb479695cc4980ce9a23fe88687069e4fec24bbc633f2257b1e788
MD5 c642a4ada9305ee03f7124f9c2dc99c6
BLAKE2b-256 0130d9953320a2af714e2685d330c9474bda0887f3aa1a57b17490eb6e2079de

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.2.dev1677168160-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.2.dev1677168160-py3-none-any.whl
Algorithm Hash digest
SHA256 cee634f993eb8e9a77cc371da13272b3216c4c9b02137acb90a2b8d17fe2994c
MD5 402736f18e4b2e907f9cee0bd080bf4b
BLAKE2b-256 e44a6b35a012bc3e17ad5c5289cec07aaabc95447a44b09b454798d67fcb5c01

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