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

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.2.4.dev1656408386.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.4.dev1656408386.tar.gz
Algorithm Hash digest
SHA256 e824741fa97fe4f69ddb4d58ff29f4bf6d82a750a3ad21f2bb65ebe1cc43693e
MD5 90d2343666affb8516fca375d0663a98
BLAKE2b-256 1b03c297efd587aaf2cd714e19425eea8ccc9d2b6ab6d0399b14cbaad660cf00

See more details on using hashes here.

File details

Details for the file openapi_python_generator-0.2.4.dev1656408386-py3-none-any.whl.

File metadata

File hashes

Hashes for openapi_python_generator-0.2.4.dev1656408386-py3-none-any.whl
Algorithm Hash digest
SHA256 916445444f7db78b86c05c43914bf504947f492e0be38d27b6625a2e534331f4
MD5 7f807922792013160f07cf8dd77b86c8
BLAKE2b-256 a8afc49c37ab8a8a82ea931ce91e51af2d1de27a8cac5e5c18f360cf5bcfa747

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