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.4.dev1679906468.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.4.dev1679906468.tar.gz
Algorithm Hash digest
SHA256 d7c2c5eb2602103dd32c12e3365ab8c935d5333ba158cd348f3621558eb2a2cb
MD5 c35da5e6307c49e43d1d598ede6ceb93
BLAKE2b-256 43f65a89247693728aa90c75611e6a5ad823cabd8d92929486550ab1bbfce42a

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.4.dev1679906468-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.4.dev1679906468-py3-none-any.whl
Algorithm Hash digest
SHA256 368fe77641140a89fb96184cd6ebc17eea2f90a30f1408f8200da2101e90db4b
MD5 7f89c78a80f625f5bd12bffb5104b7c4
BLAKE2b-256 0bfa96485cbe0afa9d21886ecc19267f54a00da87ab1e94f1ec9478ebecf9dff

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