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.4.dev1686929276.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.4.dev1686929276.tar.gz
Algorithm Hash digest
SHA256 7e8751716edb5f90181d083d0372fb390e4715d266d6581183dd59dcb191f917
MD5 4aaa513f605be66c34c1a83b7f7130a8
BLAKE2b-256 c0389da7ba3720d3ad87839d95d4bd1b2e93160665c6d71829cfe4c26d56890a

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.4.dev1686929276-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.4.dev1686929276-py3-none-any.whl
Algorithm Hash digest
SHA256 8964286596788f94f0991c8ac1fef671c4d62d05ddfac703c60a9a93628ef714
MD5 27cbd931713d8708d4258046c5a69d9e
BLAKE2b-256 56f15f23a2caba2014006164c35a325fa7dc5388196e39cd0ecc6da7866067d6

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