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.3.3.dev1656708736.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.3.dev1656708736.tar.gz
Algorithm Hash digest
SHA256 e569ffd8d93cedc60e4a935aa83abbbe2baa13431ee8a5e49d889bb1b86c4581
MD5 f4b90ce10b4e596b44cdc252ddee5497
BLAKE2b-256 ddb62f360bd866ec9685cae745e4a244d5a95cc50e629dfd39d5ca10924bf231

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.3.dev1656708736-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.3.dev1656708736-py3-none-any.whl
Algorithm Hash digest
SHA256 17e74d722525b7dbbc7e0d07a215ed524897b8e41edf7c4b4a9b7712d5e55ef6
MD5 1a18c06bc87b29d5c0e4d5c261be93c7
BLAKE2b-256 e2c86216a1393e6f97f156404e3dfd834dc6fcd029316e9f75c4c4c88c4e39d0

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