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.4.9.dev1693896586.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1693896586.tar.gz
Algorithm Hash digest
SHA256 04eaa32bd7891ba0ceb3ee2264019f5c2604b77368d61b83de40388cccb5cde3
MD5 cfcec6af0c1131b026b4c82cc6611da9
BLAKE2b-256 4cec09747cf891d615b6e48e61ad49eb713942172480686a38bb11f45ba338b5

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.9.dev1693896586-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1693896586-py3-none-any.whl
Algorithm Hash digest
SHA256 2765b0074074e3b12de80db58b1a715628870a9d75eaea739e3184cd8e0a239d
MD5 0b4e0451fcb1db77017ab1ad98ac1b04
BLAKE2b-256 9cecaea7a31761494efecd9150e48e29c4b8823fd57c73899f0fdbd7ce318420

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