diff --git a/docs/assets/lockup-dark.svg b/docs/assets/lockup-dark.svg new file mode 100644 index 0000000..5c827ac --- /dev/null +++ b/docs/assets/lockup-dark.svg @@ -0,0 +1 @@ + diff --git a/docs/assets/lockup-light.svg b/docs/assets/lockup-light.svg new file mode 100644 index 0000000..1017649 --- /dev/null +++ b/docs/assets/lockup-light.svg @@ -0,0 +1 @@ + diff --git a/docs/css/brand.css b/docs/css/brand.css index 5c95b6f..df52168 100644 --- a/docs/css/brand.css +++ b/docs/css/brand.css @@ -15,3 +15,23 @@ --md-accent-fg-color: #e0a300; --md-typeset-a-color: #7fb79f; } + +/* Centered project lockup hero on the docs home page */ +.mp-hero { + text-align: center; + margin: 1.5rem 0 2.5rem; +} +.mp-hero .mp-lockup { + margin: 0; + font-size: 0; /* collapse whitespace between the stacked variants */ + line-height: 0; +} +.mp-hero .mp-logo { + max-width: 420px; + width: 70%; + height: auto; +} +/* Light lockup by default; cream lockup in dark (slate) mode. */ +.mp-hero .mp-logo--dark { display: none; } +[data-md-color-scheme="slate"] .mp-hero .mp-logo--light { display: none; } +[data-md-color-scheme="slate"] .mp-hero .mp-logo--dark { display: inline; } diff --git a/docs/index.md b/docs/index.md index 9fb37f8..71b7af0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,11 @@ -# httpware +
+ +

+ + +

+ +
A Python HTTP client framework with sync and async clients for building resilient service clients. `httpware` is a thin opinionated wrapper around `httpx2` — it re-exports `httpx2.Request`/`httpx2.Response` as the public request/response surface, adds a middleware chain (with a built-in resilience suite: `AsyncRetry`/`Retry` + `RetryBudget`, `AsyncBulkhead`/`Bulkhead`, `AsyncCircuitBreaker`/`CircuitBreaker`, and `AsyncTimeout`), opt-in typed response decoding, and a status-keyed exception tree raised automatically on 4xx/5xx.