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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1698245917.tar.gz
Algorithm Hash digest
SHA256 f5dd0096aa20fe1c6f814a545b9b8b5b15ad0167fec8ba5b76c8a5bbd48a5ea7
MD5 8b9b6bebab24108e9d3aa1c6a4746925
BLAKE2b-256 0111167bceba9e425bb55d44591f9dc72eca19bdcd95e7a9900668e9cb572cb0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1698245917-py3-none-any.whl
Algorithm Hash digest
SHA256 8a98cb31ffb8497085cea48884ba42f38b769ea23dd9d3fbb4b622a96eeeb45e
MD5 4efec1cf7203a8a4899ca7b4777ec93e
BLAKE2b-256 479c65f8c62918217197df2b6b7ff06bf760c20f1fc4221f44034f0d4647b4c3

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