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
  • Support environment variables and .env files

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.dev1656605115.tar.gz.

File metadata

File hashes

Hashes for openapi-python-generator-0.2.4.dev1656605115.tar.gz
Algorithm Hash digest
SHA256 76799dde59cbe2a1807704ca53a925a757c4b0507338a56141b2b328b3575ec2
MD5 a302ad7ca6876b55ad7c1a18d0382183
BLAKE2b-256 fd98c0748cc011fc233efa13ba94662de4f7f04fce40b8add61e3ad353ffae2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for openapi_python_generator-0.2.4.dev1656605115-py3-none-any.whl
Algorithm Hash digest
SHA256 696a0efae6a2ac240ec44455c61ae80b092678f2c82342f80d42042ff3498926
MD5 e29ddc3bf8309fe3bf5019c2a10587a3
BLAKE2b-256 c86af1b1f7e7389480331894ae7cf6e738fca8c4909b73fbe8e38c6cdf767e28

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