Skip to main content

Use OpenAPI schema to generate command line client

Project description

OpenAPI CLI

OpenAPI CLI is a command-line interface (CLI) tool designed to interact with APIs generated by openapi-python-client. This tool allows you to configure and use API clients with ease.

Features

  • Configure API client modules
  • Validate client modules
  • Generate API client instances

Installation

To install OpenAPI CLI, use poetry:

poetry add openapi-cli[full]

To install the CLI globally, use pip:

pip install openapi-cli[full]

Optional

If you want to just use separator for your operation ids use:

poetry add openapi-cli

This will not have a cli, but you can use the separator in your code. If you want to still have ability to generate clients use the following:

poetry add openapi-cli[full] --group dev

This will keep your project build clean and will not install the cli in your production environment.

Usage

To use OpenAPI CLI in your project add the following to your pyproject.toml:

    [tool.poetry.scripts]
    your-api-cli = "openapi_cli:cli"

Then, you can run the CLI using in venv activated shell:

    your-api-cli --help

Configure the CLI

Before using the CLI, you need to configure it with your client module, base URL, and token.

Install the client module using downloaded module using openapi-python-client:

your-api-cli client install --module <name_of_your_module> 

Set the base URL and token for the client module:

openapi client api-config --base-url <url_of_your_api>
openapi client auth --token <your_token>

Patch the client to support nesting:

openapi client patch --separator <your_operation_id_separator>  # default is '_oaps_'

You can import separator to integrate it with your code:

from openapi_cli.separator import CLI_SEPARATOR

Requirements

  • Python 3.12+
  • Poetry

Setup

  1. Clone the repository.
  2. Install dependencies using poetry install.

Code Formatting

This project uses black and isort for code formatting. To format the code, run:

poetry run black .
poetry run isort .

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapi_cli-0.2.1.11.tar.gz (43.3 kB view details)

Uploaded Source

Built Distribution

openapi_cli-0.2.1.11-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

Details for the file openapi_cli-0.2.1.11.tar.gz.

File metadata

  • Download URL: openapi_cli-0.2.1.11.tar.gz
  • Upload date:
  • Size: 43.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.1 Darwin/24.0.0

File hashes

Hashes for openapi_cli-0.2.1.11.tar.gz
Algorithm Hash digest
SHA256 56264cac34c655c7b9d97fa4606c044f4bf300b99da8225e9b1d39f2b5d35477
MD5 291231ef89731375cb0d0d0fa957d907
BLAKE2b-256 c84cb471d6d7ddb6aecee801aa680115edd93e3559082578c45286f49b06fd25

See more details on using hashes here.

File details

Details for the file openapi_cli-0.2.1.11-py3-none-any.whl.

File metadata

  • Download URL: openapi_cli-0.2.1.11-py3-none-any.whl
  • Upload date:
  • Size: 38.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.1 Darwin/24.0.0

File hashes

Hashes for openapi_cli-0.2.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 eba144e6f768e243ec6915269f16f12707a2a5a19412980ff60c2d74136dc2ec
MD5 e5764fcec2e0557ebf7ee1710ca27fe3
BLAKE2b-256 c75627aac5f315007c8a1d22732bcfdec302af5b451616bc229a02b9d6c0b284

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