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.2.4.dev1656622816.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.4.dev1656622816.tar.gz
Algorithm Hash digest
SHA256 e064c13bcc0144da61a65e8fc045099e7bdd24b813f8875d15a6ca2de362c932
MD5 6f9c2dd9506e3f143b75f90f03b08dfa
BLAKE2b-256 b92cc4a43612b3ee97ff0f0af5e8d6ec0ee683a2f0d092499f092b45dc024e63

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.4.dev1656622816-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.4.dev1656622816-py3-none-any.whl
Algorithm Hash digest
SHA256 8cf2ff36b1fa05dfe92da96330087479fcfc0d4e37a300ecd5a3e15e46851148
MD5 2c49a255fdfdf0a4c647a42332b0d2c4
BLAKE2b-256 ad163a68476d36d1b528b8db50221a06e788180ae22a2d878059a1294d739bd5

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