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.4.7.dev1688457736.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.7.dev1688457736.tar.gz
Algorithm Hash digest
SHA256 8677fdb1918754b694fa98633f3e31b7b0e7054755a814a6b92c1c965d60d435
MD5 b6e42f2b488bbc1789f7f5650734021c
BLAKE2b-256 48db06de270cf85555ce8aa807b5f5dba3dd9b0e9be5dcf60bd6cfb77a1323a5

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.7.dev1688457736-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.7.dev1688457736-py3-none-any.whl
Algorithm Hash digest
SHA256 6279048a092c78d10a814e3628c6f9f7a3b16e169c7ebca77fbfc558f8add06a
MD5 ae2355d2078257a2f77419de0aae2e2e
BLAKE2b-256 10a30a36ecd3998b6667261cd172f4874da6642d522512e1c7d5f7ad9d69e357

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