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.6.dev1658218785.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.6.dev1658218785.tar.gz
Algorithm Hash digest
SHA256 def100cbbe6a45ed82de7e43396a4c6287a90ab073c78fb0f852cabbc3a60d3c
MD5 69d9cc93da92fda8843187cc2843c001
BLAKE2b-256 7f66ceef8d5ce73e469283e9b2811778ae32a00ec28fbaa46ced683387cb6177

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.6.dev1658218785-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.6.dev1658218785-py3-none-any.whl
Algorithm Hash digest
SHA256 0f9478b4eca3a3ccbf0ae0f9025a60d9b8ceceb84e3f560dd765988828ec4a76
MD5 a4ba7988caa9244a092d0faf8bdf265f
BLAKE2b-256 4d0a340257fafcbc20e54f0a82c6d69fc0ef055d4515fe21975468bec6b1db94

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