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.3.3.dev1656851782.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.3.dev1656851782.tar.gz
Algorithm Hash digest
SHA256 12cb8fff8fc5129b3f0d3a40c95d24263d9bd05b79f781b2ad8db4d1fcc5efcb
MD5 9dbb8c850bf82ee4223135925ffa377f
BLAKE2b-256 d4d1b346c50126e679aa3b4ed608a363fc7af7a4f4618e2f62df85319862ace0

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.3.dev1656851782-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.3.dev1656851782-py3-none-any.whl
Algorithm Hash digest
SHA256 c29ab25a67e269481d3bcfa6fa50d23eb03799b35297a6406e988d5221ba4c0e
MD5 afd9491e28dc1f63baf664362d9ec25a
BLAKE2b-256 6c1ab6bc1e4ea98d0989fb006939bc4c2bfed31ab8e90efdc1aec7815a6bb454

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