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

openapi_python_generator-1.1.1.dev1732810584.tar.gz (17.4 kB view details)

Uploaded Source

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.1.1.dev1732810584.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.1.1.dev1732810584.tar.gz
Algorithm Hash digest
SHA256 869c23b91b52219232e3072c203a303786be484c11c440dcebbfc473b1a37e18
MD5 0e6719dab11d4cc1e2393ef487f577fa
BLAKE2b-256 b2c44641722014d2c6cd4b09b71066bbd2805839d0954cfcd63d6d18b0c979b3

See more details on using hashes here.

File details

Details for the file openapi_python_generator-1.1.1.dev1732810584-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-1.1.1.dev1732810584-py3-none-any.whl
Algorithm Hash digest
SHA256 df0a35c7a6b7f2075d6aa6fa82f518b0dc80fab7843f58f5441acdc05c30d748
MD5 5e7ea76afe3df71b0336d1ab7ad46f62
BLAKE2b-256 9d146c2c8e0b402773f3a4eb1a20d9c2faca1bc34cf47d4c64fe4ba7ba6f2c8e

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