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.2.dev1677064529.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.2.dev1677064529.tar.gz
Algorithm Hash digest
SHA256 fcb7d1a2813ab996a8115b2113bf94131639d965e3cc321a5f10e78e183b4c1b
MD5 b8345c27d8858a72082f9f048abe28c0
BLAKE2b-256 7320405890de4d563942cb2ee10bb80b8b31a0dd9228489bff9841a83800535b

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.2.dev1677064529-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.2.dev1677064529-py3-none-any.whl
Algorithm Hash digest
SHA256 1b45122105c2365b5e69dc397204a76c2e3936f5bde0aa84c3f4934b5d5af5ad
MD5 60563bfef062c2aa773927c517d63555
BLAKE2b-256 eae1dd34339b19b0308052c4769237585875775580d5d7fcd49f40615792493e

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