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

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file openapi_python_generator-1.2.1.dev1757315868.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757315868.tar.gz
Algorithm Hash digest
SHA256 eff1bd6bca4eab285bdce78a00b97fe75196ee80008f36f24c06f45a8cf578a0
MD5 589a75b27f2b9a4e56723229f0f664f2
BLAKE2b-256 9ac63225abb2e7521353e3c34bf423cbfd399c646354ecc234d0f3b04304d7b5

See more details on using hashes here.

File details

Details for the file openapi_python_generator-1.2.1.dev1757315868-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757315868-py3-none-any.whl
Algorithm Hash digest
SHA256 4da58bb977456f180c307ce8de330efc2c2153a2095d3605feb5edc6026c704f
MD5 d658179666d1ad5b4c856e3c5f450701
BLAKE2b-256 05aa3a8bca580eb859c927a8954150ccab23aba2e3177d48ed5dfbbe0e522ec2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page