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.dev1732810474.tar.gz (17.4 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.dev1732810474.tar.gz.

File metadata

File hashes

Hashes for openapi_python_generator-1.0.1.dev1732810474.tar.gz
Algorithm Hash digest
SHA256 eaf9bcced654c812dbcab644bb5a22b80e785c1760845a79c86dea51930fbcfb
MD5 dd40de9456b7c54d8b88b56ea6909e50
BLAKE2b-256 3ef2d502b463ea92300749a905aca67309938f731171cf483facbfaa5dc97fbd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-1.0.1.dev1732810474-py3-none-any.whl
Algorithm Hash digest
SHA256 9b0ef32c9864bed86193d28eb18b50e2c5a25c83f815dc08a98633936e397471
MD5 fe2502cbdb870ecf6390481e401eb0e2
BLAKE2b-256 6fc6a51e2e3f643334dc6faec518c28baf8b2a72dcc4803f2a1c6baf279199a7

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