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.2.6.dev1656668726.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.6.dev1656668726.tar.gz
Algorithm Hash digest
SHA256 d82507885758549f696a16fae0ecf3e27ac61cf680db084304e36e208232d633
MD5 f41f14bfea91f55c28b4ec3edfa933d7
BLAKE2b-256 4e7c03e76eaef1199cb8f291387a07525f6c51d5a4a28ece758f6a0626f7f508

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.6.dev1656668726-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.6.dev1656668726-py3-none-any.whl
Algorithm Hash digest
SHA256 2695cdf53bf2cbd8629321f836c9d56e9af1dfa9c1d56ba8a45b51fb89c2adfd
MD5 ad1db82e64d9f2e7e9d525445864452b
BLAKE2b-256 4bed12fad4f6e574d4e9d17561bddd141f7e4050bcbccc4580f6fa7074c9036a

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