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.2.6.dev1656625572.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.6.dev1656625572.tar.gz
Algorithm Hash digest
SHA256 59c01677fb645c903844d33611d5c84a6cad08a1512a45f6132a2c0c1571f85d
MD5 2bdaae34175cc465b5af74605c0ae409
BLAKE2b-256 aa7e77571b7295960deeaa660fdb2550cc69ada3313646fd296de5b581682187

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.6.dev1656625572-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.6.dev1656625572-py3-none-any.whl
Algorithm Hash digest
SHA256 1ec141dd2a1d5505cae44d8c7af85e90ac904b4f26a16946af441d5eeb47cb7c
MD5 a5b9f73809d9c88c30a8d9a10c36ca55
BLAKE2b-256 343034468184ba49baee469aeadfd2e2978cc624245dd50f957405a95f7bca4e

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