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.3.4.tar.gz (15.2 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.3.4-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: openapi-python-generator-0.3.4.tar.gz
  • Upload date:
  • Size: 15.2 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.3.4.tar.gz
Algorithm Hash digest
SHA256 fbda81ed172fbaafb3d194d4bd35a2550d3c017f8d2cb325ecf377038b918ac3
MD5 f128b090c98513026b68ce377799a8c0
BLAKE2b-256 e7d5c78b22b6a4bec1a99aba5da13c2d81e0e8a2ca1c354454ca0985aea6665e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 92094991317913b3c45fd10abbf11866ba7f4be0f30bbfa424e5bae7c1e3c1f6
MD5 80ddf47e45413cfb7be82307a74823c3
BLAKE2b-256 7fba0aa4b121b0c0f1e2e5904caa4f2453affec7b4cd59e4d27f06afbad0d483

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