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.2.5.tar.gz (13.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.2.5-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi-python-generator-0.2.5.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.13 Linux/5.13.0-1031-azure

File hashes

Hashes for openapi-python-generator-0.2.5.tar.gz
Algorithm Hash digest
SHA256 3b507f9d84d0628f7f30fc9d76438f205b72e761b5678b72717fdb20d8763235
MD5 08304fbc387b78d9f5bfefda4c01c451
BLAKE2b-256 82ebe12501a19aaa9471071f39ad1e64d2822c27e362e22431c439c7c185208d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6794ab7ed183bedd038c77f3b476c2f8222211a56ea61951e2cd9bc442649184
MD5 16e60ee124ffd63a09629e82f6da4100
BLAKE2b-256 6f856d10c31ee3db9b10c5cd1885a73f919897d4b5a70f32e482a05cff01ea44

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