Skip to content

Commit a6d03f4

Browse files
committed
docs: refactor README to link to published docs site
1 parent 2897cd8 commit a6d03f4

1 file changed

Lines changed: 7 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77

88
**Async HTTP client framework for Python.**
99

10-
`httpware` is a typed, async HTTP client library built on `httpx2` with a protocol-based seam so the transport is swappable. Middleware composes via an onion model. Pydantic and msgspec response decoding ship out of the box. `RecordedTransport` replaces respx for transport-level tests.
10+
`httpware` is a typed, async HTTP client library with a protocol-based seam so the transport is swappable (`httpx2` ships as the default). Middleware composes via an onion model. Pydantic and msgspec response decoding ship out of the box. `RecordedTransport` replaces `respx` for transport-level tests.
1111

12-
> **Status:** Pre-1.0 (0.1.0 alpha). Public API is subject to change between minor releases until v1.0. Resilience middleware (retry / timeout / bulkhead), streaming, and observability are not yet shipped — track progress on GitHub.
12+
> **Status:** Pre-1.0 (0.1.0 alpha). Public API is subject to change between minor releases until v1.0. Resilience middleware (retry / timeout / bulkhead), streaming, and observability are not yet shipped.
1313
1414
## Install
1515

@@ -23,7 +23,7 @@ Optional extras:
2323
pip install httpware[msgspec] # MsgspecDecoder
2424
```
2525

26-
(`otel`, `niquests`, and `all` extras are declared but their integrations have not shipped yet.)
26+
(`otel`, `niquests`, and `all` extras are declared; integrations have not shipped yet.)
2727

2828
## Quickstart
2929

@@ -43,20 +43,12 @@ async def main() -> None:
4343
print(user.name)
4444
```
4545

46-
## What ships in 0.1.0
46+
## 📚 [Documentation](https://httpware.readthedocs.io)
4747

48-
- **`AsyncClient`** — eight HTTP method shortcuts (`get`, `post`, `put`, `patch`, `delete`, `head`, `options`, `request`) with typed `response_model` overloads; per-call overrides for `headers`, `params`, `cookies`, `timeout`, `json`, `content`; httpx-style `base_url` join; `with_options(...)` returns a view sharing the same transport.
49-
- **Transport-agnostic seam.** `httpx2` is confined to `httpware.transports.httpx2.Httpx2Transport`. Implement the `Transport` protocol to swap backends.
50-
- **Middleware foundation.** `Middleware` protocol, `Next` type alias, and phase decorators (`@before_request`, `@after_response`, `@on_error`). The chain is composed at `AsyncClient` construction; consumers don't compose chains themselves.
51-
- **Pluggable response decoding.** `PydanticDecoder` (default) with cached `TypeAdapter`; `MsgspecDecoder` via `httpware[msgspec]`.
52-
- **`RecordedTransport`** — built-in test double with a route table, observed-request list, and `aclose_calls` counter.
53-
- **Status-keyed exception hierarchy** — `StatusError`, 4xx / 5xx subclasses, plain typed fields (`status: int`, `body: bytes`, `headers`, `json`, `request_method`, `request_url`). Pickleable; userinfo redacted in `__repr__`.
54-
- **No `httpx2` exception types** leak through `httpware`. The transport seam maps them to `httpware` exceptions.
48+
## 📦 [PyPI](https://pypi.org/project/httpware)
49+
50+
## 📝 [License](./LICENSE)
5551

5652
## Part of `modern-python`
5753

5854
Browse the full list of templates and libraries in [`modern-python`](https://github.com/modern-python) — see the org profile for the categorized index.
59-
60-
## License
61-
62-
MIT — see [LICENSE](./LICENSE).

0 commit comments

Comments
 (0)