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

File metadata

File hashes

Hashes for openapi-python-generator-0.3.4.dev1657525488.tar.gz
Algorithm Hash digest
SHA256 4db922900ab0843ece0a1a9a268984b9fbaac8cdd64bc8662cf5ab5396a80eea
MD5 cb5b7ad66051067e0d16f6dc5276fb44
BLAKE2b-256 c26c05b12b546f5dcd9fa65158b5b4f33e2c8e526749226b664d5e57ab646890

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.4.dev1657525488-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.4.dev1657525488-py3-none-any.whl
Algorithm Hash digest
SHA256 3bc802ba26f69857a8f878cc5383192a1d316f10da095493500e448d0f998d07
MD5 1fad264245b115e25177b22443e748a5
BLAKE2b-256 3960610f0110fc4f389b2e2fa031564210b0939ce8b5a3ad87802ae4683ed6a1

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