OPENAPI-PYTHON-CLIENT(1)

📦
version 0.28.3 · 2 versions
, in fedora 43, fedora 44

💖 openapi-python-client(1) — the manual page, but make it cute 💖

okay so bestie, welcome to openapi-python-client, section 1 of the user commands manuals. this is the manpage for openapi-python-client version: 0.28.2. she generates Python clients and she does it flawlessly, no cap. 🦋

✨ NAME ✨

openapi-python-client — manual page for openapi-python-client version: 0.28.2

🌸 SYNOPSIS 🌸

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

💅 DESCRIPTION 💅

Generate a Python client from an OpenAPI document. that's it, that's the whole vibe. feed her an OpenAPI doc, get a whole Python client back. iconic behavior fr fr. 👑

🎀 OPTIONS 🎀

  • --version — prints the version and then dips. short and sweet. ✨
  • --install-completion — installs completion for the shell you're currently living in. 🐚
  • --show-completion — shows you the completion for your current shell so you can copy it or customize the installation yourself. iykyk. 🫶
  • --help — shows this message and exits. the classic. the moment. 💖

⭐ Commands ⭐

  • generate — generate a new OpenAPI Client library. the main character, lowkey. 🌈

🔥 GENERATE SUBCOMMAND 🔥

options for the generate subcommand, coming right up bestie:

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). bring ur own aesthetic. 🎨
  • --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. 🫶
bestie listen: --overwrite defaults to no-overwrite, so if a client already exists she will NOT touch it unless you say so. protect ur files, periodt. 💀

and that's the whole page! written by the openapi-python-client girlies, version 0.28.2, dated October 2025. mwah, love u, go generate something gorgeous. 💖✨🎀🦋🌸💅🫶👑🌈⭐🍓🧚💜

📦 where this page comes from