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

Built Distribution

File details

Details for the file openapi-python-generator-0.4.3.dev1677757205.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.4.3.dev1677757205.tar.gz
Algorithm Hash digest
SHA256 dfd8f202739285477e2257a866be896ec1731b6b9a36301cd91cb8c25583d098
MD5 f8e24645a3297603cd19eb4d67a0acd2
BLAKE2b-256 b167f023343ce2c346652da8bb41bff6f13d8dad3ef3e531ad8d95d7b54c08e4

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.4.3.dev1677757205-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.4.3.dev1677757205-py3-none-any.whl
Algorithm Hash digest
SHA256 3f12484d079c3c00a7d7249003709be18b829cae54b2f24b8ccb9814b4a2d931
MD5 443a89b6f194690cf02032866e53e606
BLAKE2b-256 4f3cacffb0a5e44398cd6f645a934226b1348a0b1261dd635f25cb68927bb63c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page