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.3.dev1656861517.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.3.dev1656861517.tar.gz
Algorithm Hash digest
SHA256 ae476b8d36c32f0553e69a774474873b5eeec54e63168000750871c0579426bb
MD5 ab2c35f6a02a5e117656ed758ad98b8f
BLAKE2b-256 9feb8099d56b668f836072d05d54847984285c0828d7fd9a7df4f1f03ae5e20c

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.3.dev1656861517-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.3.dev1656861517-py3-none-any.whl
Algorithm Hash digest
SHA256 546e9190c9955b68de4ed98a8bc885cc617fa18152b9cdd069d7fefe28c433be
MD5 41289861f1e78e0cba4ada20c30383fa
BLAKE2b-256 49136c4b33252a90b008f3aeacbca5d27e10e64821bced7848e362fa9c0f8097

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