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.dev1757315625.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757315625.tar.gz
Algorithm Hash digest
SHA256 e05c078f13359393263c6cdbc3cbd18bd933c22566f5107bde301a23cedda3b6
MD5 1ac88a16fe722a7d1ba2332defee7333
BLAKE2b-256 40451b9eaec9464b60b972ced30031efea22920763dea4aa75849dd116d92310

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-1.2.1.dev1757315625-py3-none-any.whl
Algorithm Hash digest
SHA256 bdf291900d0a4fea2099ab3b87556c9a40df931b3b4010e6f3e5a0226308db2c
MD5 cc6bb86ad1a9355399fd5fc8df3ab6cd
BLAKE2b-256 27bd176d921763f3ea132e5a211c3ba2d8838da14155fb8b10264471938cd1cf

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