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.9.dev1695016973.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1695016973.tar.gz
Algorithm Hash digest
SHA256 5fe140ad90912eb269c81a18c6fdedea414efbd8bed462d74b103f394e2f9978
MD5 4535f1efe5987220c9fd45cf434e2722
BLAKE2b-256 32602e8702e1585d1da0793e953c90d1a4241cceca0077a401bcffb05d83dce5

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.9.dev1695016973-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.9.dev1695016973-py3-none-any.whl
Algorithm Hash digest
SHA256 fea2b98fb79d20d334b617d148f80049367a3ae0205c5604abd64fb07ffeb1c9
MD5 80c14546e02fd59d69187b476f776ee6
BLAKE2b-256 a526f99b74ba3a3b7bf30f48a9d0e75868a45c25adf3a861b0b5cbb0b91a508c

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