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

openapi-python-generator-0.4.1.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapi_python_generator-0.4.1-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file openapi-python-generator-0.4.1.tar.gz.

File metadata

  • Download URL: openapi-python-generator-0.4.1.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.16 Linux/5.15.0-1033-azure

File hashes

Hashes for openapi-python-generator-0.4.1.tar.gz
Algorithm Hash digest
SHA256 f91bf0f2c3becf604d8b73ad087d7d7e8a11a2eef311ecc3e499723a00f4dc67
MD5 c6707f24d8b47cd621de0fdbdf2f25a6
BLAKE2b-256 cf0de870b2233e432c44b676db0f0d7cd433e16e91ec0f03898e7f152e1d5fda

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 946170df180c5fec8021d61c1f594bc91f0274defd0ffbdd17b302d2ee13cc99
MD5 96631c54acf81eed3fad639a73858c05
BLAKE2b-256 9d464d34377395e2b96cf063844e854e23428a8ca905346802b4bfc619dbe18b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page