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.2.dev1677754498.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.2.dev1677754498.tar.gz
Algorithm Hash digest
SHA256 c6e5d2b21accff6a6f8a40f06ff6e42c8311344d1cf5a2200116b1fec3a0c0d6
MD5 3356ce52cf47775306ba3673868908ed
BLAKE2b-256 7dc56746fa939a67ad9caa976534a7866b665b9c315032429382480e454a7844

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.2.dev1677754498-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.2.dev1677754498-py3-none-any.whl
Algorithm Hash digest
SHA256 0f25d111d6a35505f88751d0aeedf116b4eca15f758350177943dacbd384b4f6
MD5 420af2c8fd3bf2331503eb014bdf328f
BLAKE2b-256 18be26534198559ca3e1d635c752789de2d62edae9888cae651f7b9416e42acf

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