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

File metadata

File hashes

Hashes for openapi-python-generator-0.3.3.dev1656707091.tar.gz
Algorithm Hash digest
SHA256 321f29ffc2a47d0fb6f9957698656addc021e642193346c8f48eb49e892975d1
MD5 400c9870e4db09c4aa6c19d0728ec507
BLAKE2b-256 434e511d856fd7f6bbf61315ea07fc995ab9e5bfe54f29c120cb98acdb08e5f9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.3.3.dev1656707091-py3-none-any.whl
Algorithm Hash digest
SHA256 63fcdcc7593a77938e96ddd50d76a9b7c2cc23f4741057c067c0d0213d361bb0
MD5 fdf9b2928bbe02130f1f8db951d1b69d
BLAKE2b-256 04cb5aba120500966042dde1f727686a27075ada541129903722fa80a4245af2

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