openapi-python-client - Man Page

manual page for openapi-python-client 0.24.4

Synopsis

openapi-python-client [Options] COMMAND [ARGS]...

Description

Generate a Python client from an OpenAPI document

Options

--version

Print the version and exit

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

--help

Show this message and exit.

Commands

generate

Generate a new OpenAPI Client library

Command Options

--url TEXT

A URL to read the OpenAPI document from

--path PATH

A path to the OpenAPI document

--custom-template-path DIRECTORY

A path to a directory containing custom template(s) --meta [none|poetry|setup|pdm]

The type of metadata you want to generate.

[default: poetry]

--file-encoding TEXT

Encoding used when writing generated [default: utf-8]

--config PATH

Path to the config file to use

--fail-on-warning / --no-fail-on-warning

[default: no-fail-on-warning]

--overwrite / --no-overwrite

Overwrite the existing client if it exists [default: no-overwrite]

--output-path PATH

Path to write the generated code to. Defaults to the OpenAPI document title converted to kebab or snake case (depending on meta type). Can also be overridden with `project_name_override` or `package_name_override` in config.

Info

March 2025 openapi-python-client 0.24.4