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.3.4.dev1657178631.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.4.dev1657178631.tar.gz
Algorithm Hash digest
SHA256 935489cba15b66ee98d7ed9adfb6b78e14627520dda3dbcbfab5a47d1fdae2e6
MD5 602c19f84ca831b4e4e200d90ffefc50
BLAKE2b-256 9d25882d69d556acea86a0d3eea1b2e2c405e97c77e86c4a8950fe4299838e17

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.4.dev1657178631-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.4.dev1657178631-py3-none-any.whl
Algorithm Hash digest
SHA256 02d58293428fe7ca027e1c0565499da4f2366f4b1c5bec98950c4d2afb9ba2fc
MD5 7089adbf33e8274a2200358d8577d263
BLAKE2b-256 d3f263d27d9ef916b74a7081be89b6dba7bdb459df070d4bb96608f88e077203

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