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 ab-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


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

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

File details

Details for the file ab_openapi_python_generator-2.1.4.dev1768280320.tar.gz.

File metadata

File hashes

Hashes for ab_openapi_python_generator-2.1.4.dev1768280320.tar.gz
Algorithm Hash digest
SHA256 d15aa88f39fe07e017a939df95aa0b4c3adebaa9f8874a96011bcee887fc3086
MD5 3d512c13d17ab1b279e0802a81aefc1a
BLAKE2b-256 909d04142bef2708756c80c7fe590c8b489af4cbad7fc14df95be4ff4ad10de5

See more details on using hashes here.

File details

Details for the file ab_openapi_python_generator-2.1.4.dev1768280320-py3-none-any.whl.

File metadata

File hashes

Hashes for ab_openapi_python_generator-2.1.4.dev1768280320-py3-none-any.whl
Algorithm Hash digest
SHA256 0dd7659bbe7dee4130a1173224bc87331aae43bb6d67e3ea0261b84519abea56
MD5 badeda013bc1c01f8917ba1574f00bc0
BLAKE2b-256 2f148c7f88c462d25f088f363d8d7b8e0876c5906cdb94fb81fb3d4d36d39ad2

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