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.8.dev1693896540.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.8.dev1693896540.tar.gz
Algorithm Hash digest
SHA256 ad6114ed736010eb33368023b2a89c353e816efd91cfbe34f162e79584f7f475
MD5 68dc1fb2e674b039b9fedc8db94bc728
BLAKE2b-256 9e6fc474faf9f569b369f15fb73d7e111babd1e829fb4efed93b9e61c67fa1cd

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.8.dev1693896540-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.8.dev1693896540-py3-none-any.whl
Algorithm Hash digest
SHA256 42b1d08f04085ec93ac1901c42bcd71b905a2cafc9a5843432ed3ff28934834e
MD5 9e6b8a08e0c85fe71a74c5225f65f270
BLAKE2b-256 b9f4a6927a9e0f74a9423388e3d5f1f2791b58b09fdef44a8e1f2694abd2a541

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