Skip to content

Refactor installation instructions in README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Minibrams merged 1 commit into from
Apr 28, 2026
+4 −7
Merged

Refactor installation instructions in README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,8 @@
## Installation

```bash
# If you want to define your own HTTP transport (requests, asyncio, ...)
uv add openapi-python

# For built-in httpx transport:
uv add openapi-python[httpx]
uv add openapi-python # If you want to define your own HTTP transport (requests, asyncio, ...)
uv add openapi-python[httpx] # Ships with an `httpx` transport
```


Expand All @@ -20,10 +17,10 @@ uv add openapi-python[httpx]
Generate a client from an OpenAPI spec in `openapi.json`:

```bash
# Types + HTTP client/transport
# Types + HTTP transport
uv run openapi-python generate --spec ./openapi.json --out ./generated

# Just types, use your own HTTP client/transport
# Types
uv run openapi-python generate --spec ./openapi.json --out ./generated --transport-mode protocol-only
```

Expand Down
Loading