Skip to main content

Generate modern Python clients from OpenAPI

Project description

triaxtec Code style: black codecov PyPI version shields.io

openapi-python-client

Generate modern Python clients from OpenAPI

This project is still in early development and does not support all OpenAPI features

Why This?

The Python clients generated by openapi-generator support Python 2 and therefore come with a lot of baggage. This tool aims to generate clients which:

  1. Use all the latest and greatest Python features like type annotations and dataclasses
  2. Don't carry around a bunch of compatibility code for older version of Python (e.g. the six package)
  3. Have better documentation and more obvious usage instructions

Additionally, because this generator is written in Python, it should be more accessible to contribution by the people using it (Python developers).

Installation

pip install openapi-python-client

Then, if you want tab completion: openapi-python-client --install-completion

Usage

Create a new client

openapi-python-client generate --url https://my.api.com/openapi.json

This will generate a new client library named based on the title in your OpenAPI spec. For example, if the title of your API is "My API", the expected output will be "my-api-client". If a folder already exists by that name, you'll get an error.

Update an existing client

openapi-python-client update --url https://my.api.com/openapi.json

What You Get

  1. A pyproject.toml file with some basic metadata intended to be used with Poetry.
  2. A README.md you'll most definitely need to update with your project's details
  3. A Python module named just like the auto-generated project name (e.g. "my_api_client") which contains:
    1. A client module which will have both a Client class and an AuthenticatedClient class. You'll need these for calling the functions in the api module.
    2. An api module which will contain one module for each tag in your OpenAPI spec, as well as a default module for endpoints without a tag. Each of these modules in turn contains one function for calling each endpoint.
    3. A models module which has all the classes defined by the various schemas in your OpenAPI spec

OpenAPI features supported

  1. All HTTP Methods
  2. JSON and form bodies, path and query parameters
  3. float, string, int, datetimes, string enums, and custom schemas or lists containing any of those
  4. html/text or application/json responses containing any of the previous types
  5. Bearer token security

Contributors

Project details


Release history Release notifications | RSS feed

This version

0.1.1

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-client-0.1.1.tar.gz (14.1 kB view hashes)

Uploaded Source

Built Distribution

openapi_python_client-0.1.1-py3-none-any.whl (19.0 kB view hashes)

Uploaded Python 3

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