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.dev1677751002.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.2.dev1677751002.tar.gz
Algorithm Hash digest
SHA256 559b63eade03eb593b7511d43b1107aefd0338ca708d5331e7b230edf0971fb2
MD5 3e8a93c2016c96b6e0e4cd6f9b82a7b6
BLAKE2b-256 606692565d4408010682c790c7afd643d5b9ee3894de039f1ff9671380e23c1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.2.dev1677751002-py3-none-any.whl
Algorithm Hash digest
SHA256 e819640f81250174fde9812af5b4bfee5d29d7c7a190bd8d59dd468cd1b88bb4
MD5 72cc995dc09c677587c1c74e8c17c147
BLAKE2b-256 3d6e0c720f2807dd1f9b416c23f296bedaef686fbebb1246b4ef45773702c519

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