Skip to content

Commit 0648aa0

Browse files
committed
docs: Update usage.md
1 parent 503a7a6 commit 0648aa0

File tree

2 files changed

+24
-23
lines changed

2 files changed

+24
-23
lines changed

openapi_python_client/cli.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66
import typer
77

88
from openapi_python_client import MetaType
9+
from openapi_python_client.config import Config
910
from openapi_python_client.parser.errors import ErrorLevel, GeneratorError, ParseError
1011

11-
from .config import Config
12-
1312
app = typer.Typer()
1413

1514

usage.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `openapi-python-client`
22

3-
Generate a Python client from an OpenAPI JSON document
3+
Generate a Python client from an OpenAPI JSON document
44

55
**Usage**:
66

@@ -10,20 +10,19 @@ $ openapi-python-client [OPTIONS] COMMAND [ARGS]...
1010

1111
**Options**:
1212

13-
* `--version`: Print the version and exit [default: False]
14-
* `--config PATH`: Path to the config file to use
15-
* `--install-completion`: Install completion for the current shell.
16-
* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
17-
* `--help`: Show this message and exit.
13+
- `--version`: Print the version and exit [default: False]
14+
- `--install-completion`: Install completion for the current shell.
15+
- `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
16+
- `--help`: Show this message and exit.
1817

1918
**Commands**:
2019

21-
* `generate`: Generate a new OpenAPI Client library
22-
* `update`: Update an existing OpenAPI Client library
20+
- `generate`: Generate a new OpenAPI Client library
21+
- `update`: Update an existing OpenAPI Client library
2322

2423
## `openapi-python-client generate`
2524

26-
Generate a new OpenAPI Client library
25+
Generate a new OpenAPI Client library
2726

2827
**Usage**:
2928

@@ -33,15 +32,17 @@ $ openapi-python-client generate [OPTIONS]
3332

3433
**Options**:
3534

36-
* `--url TEXT`: A URL to read the JSON from
37-
* `--path PATH`: A path to the JSON file
38-
* `--custom-template-path DIRECTORY`: A path to a directory containing custom template(s)
39-
* `--meta [none|poetry|setup]`: The type of metadata you want to generate. [default: poetry]
40-
* `--help`: Show this message and exit.
35+
- `--url TEXT`: A URL to read the JSON from
36+
- `--path PATH`: A path to the JSON file
37+
- `--custom-template-path DIRECTORY`: A path to a directory containing custom template(s)
38+
- `--meta [none|poetry|setup]`: The type of metadata you want to generate. [default: poetry]
39+
- `--file-encoding TEXT`: Encoding used when writing generated [default: utf-8]
40+
- `--config PATH`: Path to the config file to use
41+
- `--help`: Show this message and exit.
4142

4243
## `openapi-python-client update`
4344

44-
Update an existing OpenAPI Client library
45+
Update an existing OpenAPI Client library
4546

4647
**Usage**:
4748

@@ -51,9 +52,10 @@ $ openapi-python-client update [OPTIONS]
5152

5253
**Options**:
5354

54-
* `--url TEXT`: A URL to read the JSON from
55-
* `--path PATH`: A path to the JSON file
56-
* `--custom-template-path DIRECTORY`: A path to a directory containing custom template(s)
57-
* `--meta [none|poetry|setup]`: The type of metadata you want to generate. [default: poetry]
58-
* `--help`: Show this message and exit.
59-
55+
- `--url TEXT`: A URL to read the JSON from
56+
- `--path PATH`: A path to the JSON file
57+
- `--custom-template-path DIRECTORY`: A path to a directory containing custom template(s)
58+
- `--meta [none|poetry|setup]`: The type of metadata you want to generate. [default: poetry]
59+
- `--file-encoding TEXT`: Encoding used when writing generated [default: utf-8]
60+
- `--config PATH`: Path to the config file to use
61+
- `--help`: Show this message and exit.

0 commit comments

Comments
 (0)