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.3.dev1678780727.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.3.dev1678780727.tar.gz
Algorithm Hash digest
SHA256 977df60550540e1fa832850e60465c0d331fa9e9f30ead15203cc0b319d6af8e
MD5 a2ccfe7925592715236a6693924671aa
BLAKE2b-256 0b1aee3151b429a1e3f3b3a3057eb10c356c0e22960248f5121e0d1a6f840e54

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.3.dev1678780727-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.3.dev1678780727-py3-none-any.whl
Algorithm Hash digest
SHA256 b2065ffc49897e0c3c43e69792175f07e455ca5c6395a925e96569ca798bf83e
MD5 217d34827dba63cf10f765784d09104b
BLAKE2b-256 d2d5e828fefcde4f628cb29fc28a777d32b2dfa098d93899faf883c22c959348

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