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.6.dev1671455179.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.3.6.dev1671455179.tar.gz
Algorithm Hash digest
SHA256 91c4ca1e30e2c175d87584eee5b05ca192ebcdc0bb929821c0f4f99a99fb694d
MD5 8e6352efec94fc59db58d3944273fe37
BLAKE2b-256 41ce9b2a8052f9e99b8a693576d117addc2cf08576455a8775aeaa2e7dc42b49

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.3.6.dev1671455179-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.3.6.dev1671455179-py3-none-any.whl
Algorithm Hash digest
SHA256 62d6c76384ccf5d2e2da361a52e7ea8939298e8bcf06a31a2895281e04318732
MD5 64876a926ffbf8f73aa97dcfe8f3fc4a
BLAKE2b-256 72bb3f739bb6ecd4a07d28b15dbeca395cb6bf6e9314091237d47c75c5103317

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