Skip to main content

Openapi Python Generator

Project description

Openapi Python Generator

PyPI Status Python Version License

Read the documentation at https://openapi-python-generator.readthedocs.io/ Tests Codecov

pre-commit Black

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

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

File metadata

File hashes

Hashes for openapi-python-generator-0.2.4.dev1656406669.tar.gz
Algorithm Hash digest
SHA256 d1e5b66f781529b541980badceeed27a2e50352275fd9618753797340977f1fc
MD5 8013545c38bd709e4d4c5ccc46c56406
BLAKE2b-256 537fa61c67a29d63b8128e0986bbd9c4eb02f118a5e104642914eec58215d8c3

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.4.dev1656406669-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.4.dev1656406669-py3-none-any.whl
Algorithm Hash digest
SHA256 a9d53972b3f5df31e96eb3e875131c8c8763f4e235f803e25fb10f055e08c4d0
MD5 140be09767781ebf590887a4da4ded77
BLAKE2b-256 5a25f31e409b41339f1e1a8b50743f24318fd62416950c5ce07da7a59169bf3a

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