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.1.dev1656668787.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.1.dev1656668787.tar.gz
Algorithm Hash digest
SHA256 fe822d94b1820e779ce547511b7254b5e77ae93f5371311ed345abdcadcc28b9
MD5 927304a8184cac0641033aff6dd0211c
BLAKE2b-256 2033190868823ee106c1c498f66a5005cb808467e673010681d7b02ac1cf07ad

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.1.dev1656668787-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.1.dev1656668787-py3-none-any.whl
Algorithm Hash digest
SHA256 48fbc0b8f24afeb58491a4616d55d6114c1c56c8799a403479c49ca70e18da68
MD5 5a0683fa75622753dac84722e82af8b2
BLAKE2b-256 ec4131daf42a52685aef202723c2957c8a630b73569982bbcb0789771c8065e3

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