openapi-python-client - Man Page

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

Generate a Python client from an OpenAPI document

--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.

Options for the generate subcommand:

Usage: openapi-python-client generate [OPTIONS]

  Generate a new OpenAPI Client library

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|uv]
                                  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.
  --help                          Show this message and exit.