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.7.dev1686934781.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.7.dev1686934781.tar.gz
Algorithm Hash digest
SHA256 bd4fde7e44307368b0da47d3b182330265c28bf26d3452643af65b94bf8db200
MD5 7f57d0d5fa0e9a11531eee4f86247617
BLAKE2b-256 dac5af253960e9eae603a3893018c4c3ac1ec4e238f738e3abc323e627c842b0

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.7.dev1686934781-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.7.dev1686934781-py3-none-any.whl
Algorithm Hash digest
SHA256 fb3ed2df10d9107da08cc2de5ddc4697dd2d2a15ae370f1d892ed51dfcf43d6e
MD5 9d4ba61e96821b5c143d0ea7b694d8ad
BLAKE2b-256 09668f3cdca73e0db84eb8b2083851296eb0a0b6ddba6209fcb22a1bfb5b9797

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