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.2.4.dev1656612324.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.4.dev1656612324.tar.gz
Algorithm Hash digest
SHA256 5a662cc01cc84d3dbcd96b864d8f4bfaf3ddfeb998e41380a06cb12305f4d086
MD5 fdb6ee843afe1f07f81bdf7a42f94842
BLAKE2b-256 5e34fac7a43f1eae6ffd3789834de5e590bd7c6d27b2f4a04fdfb20769b98dcc

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.4.dev1656612324-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.4.dev1656612324-py3-none-any.whl
Algorithm Hash digest
SHA256 35b0a0806a117e1d505c0c20cc554f6f6ff8ce804c2cf34819610561eca04cc4
MD5 5e220eb05c6105817872b20e1cffb8c5
BLAKE2b-256 7f5259d42c773750c13508920c1563809f8197d1cdaf32228c0ce471d0db795e

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