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-2.0.1.dev1758614037.tar.gz (21.8 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-2.0.1.dev1758614037.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-2.0.1.dev1758614037.tar.gz
Algorithm Hash digest
SHA256 aa87264441ec0c8df2841cdb9fa3d6222903dcb24cb30725654869c2f5fa3dfe
MD5 5992dc17bdb3833b6d3f1bf05a874f63
BLAKE2b-256 91da0b9a4aa438ba9dbd3eb84accfd21603c869efebdf5d891ac3745786e0901

See more details on using hashes here.

File details

Details for the file openapi_python_generator-2.0.1.dev1758614037-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-2.0.1.dev1758614037-py3-none-any.whl
Algorithm Hash digest
SHA256 47ae8e60e3740b54a5db59e2448675f1766c4f83fff70541b8489bb30e8d9b11
MD5 4c18b1ca6fe14522da245f6123ce6627
BLAKE2b-256 914463b285ac814e7cd0ab361d061bedee9105869989c80c835d62a4fc5acd22

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