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

This version

0.4.8

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.8.tar.gz (16.4 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.8-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file openapi_python_generator-0.4.8.tar.gz.

File metadata

  • Download URL: openapi_python_generator-0.4.8.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.17 Linux/5.15.0-1041-azure

File hashes

Hashes for openapi_python_generator-0.4.8.tar.gz
Algorithm Hash digest
SHA256 b92e3de901e03fd47e0d9bb0d641f03184dbc5c3f4b009908fd29e546423c5e8
MD5 153b4c922278ada2eb161e02376a15ac
BLAKE2b-256 4c3966c60042400d80a6c40159108c5623a097b17c0efca64ffabbb611fd76ed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b844dbed191527c274f6f365f4d046876bfd532a169e758514d7570f4bac9f45
MD5 5c093ffb3ceaf7f7e9ee5e5d3a705ac2
BLAKE2b-256 60c5454ba2d7d6af446d45a6e575d46a45e32de23c769880049013ac7f693403

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