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-1.0.1.dev1732795530.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file openapi_python_generator-1.0.1.dev1732795530.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.0.1.dev1732795530.tar.gz
Algorithm Hash digest
SHA256 2c91c8417acad9acc7244d56538555e6e7ea2a6c4552fbf5da8da402658d3b61
MD5 e9d3a1bb43b9a682cdc3919d2d6cf6cf
BLAKE2b-256 72d8471000b52509cf021e04e2074a4ec761b62c1e8bdd566fb1acc2e1b6879c

See more details on using hashes here.

File details

Details for the file openapi_python_generator-1.0.1.dev1732795530-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-1.0.1.dev1732795530-py3-none-any.whl
Algorithm Hash digest
SHA256 19c7fec830920eae5fe4ecb2440877c7dadf47f44f42c1cebf7a73fcc630994f
MD5 6f037ebf184025223c8d09d1629abd50
BLAKE2b-256 0297302840e8f6e5bb6efba8df20289661caefb85179ab99fbea86aad54b16ec

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