From 7cdb2c52402dd443635da813a520001d5db3ca5a Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 2 Jul 2025 11:55:06 +0100 Subject: [PATCH 1/3] Neaten up docs --- README.md | 39 +++++++++++++-------------------------- docs/about.md | 5 ++--- docs/index.md | 18 +++--------------- docs/networking.md | 1 - 4 files changed, 18 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 9fcda9c..63b1bbf 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,6 @@ --- -*The following is a [design proposal](https://www.encode.io/httpnext/) and is not yet complete. The work is well underway, tho be aware that some parts of the codebase are still under development.* - ---- - A complete HTTP framework for Python. *Installation...* @@ -51,35 +47,26 @@ Serving on http://127.0.0.1:8080/ (Press CTRL+C to quit) The [HTTPX 1.0 design proposal](https://www.encode.io/httpnext/) is now available. -* [Quickstart](https://www.encode.io/httpnext/quickstart.md) -* [Clients](https://www.encode.io/httpnext/clients.md) -* [Servers](https://www.encode.io/httpnext/servers.md) -* [Requests](https://www.encode.io/httpnext/requests.md) -* [Responses](https://www.encode.io/httpnext/responses.md) -* [URLs](https://www.encode.io/httpnext/urls.md) -* [Headers](https://www.encode.io/httpnext/headers.md) -* [Content Types](https://www.encode.io/httpnext/content-types.md) -* [Connections](https://www.encode.io/httpnext/connections.md) -* [Network Backends](https://www.encode.io/httpnext/networking.md) +* [Quickstart](https://www.encode.io/httpnext/quickstart) +* [Clients](https://www.encode.io/httpnext/clients) +* [Servers](https://www.encode.io/httpnext/servers) +* [Requests](https://www.encode.io/httpnext/requests) +* [Responses](https://www.encode.io/httpnext/responses) +* [URLs](https://www.encode.io/httpnext/urls) +* [Headers](https://www.encode.io/httpnext/headers) +* [Content Types](https://www.encode.io/httpnext/content-types) +* [Connections](https://www.encode.io/httpnext/connections) +* [Network Backends](https://www.encode.io/httpnext/networking) --- # Collaboration -The design repository for this work is currently private. We are looking towards a development model that encourages a calm focused working environment, and are currently taking a little time to work through expectations & boundaries for contributions to the codebase. - ---- - -## Background - -If you've been working with 0.x versions of HTTPX you'll notice significant API differences. - -Version 1.0 provides a much more tightly constrained API. It has a lighter installation footprint, far more obvious type annotations, and a lower overall complexity. +The repository for this project is currently private. -For example: +We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.* -* Client code [before](https://github.com/encode/httpx/blob/master/httpx/_client.py) and [after](https://github.com/encode/httpnext/blob/dev/src/httpx/_client.py). -* Response code [before](https://github.com/encode/httpx/blob/master/httpx/_models.py#L515) and [after](https://github.com/encode/httpnext/blob/dev/src/httpx/_response.py). +If you're interested in a position working on this project, please send an intro. --- diff --git a/docs/about.md b/docs/about.md index 858d860..46d7564 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,6 +1,6 @@ # About -This work is a design proposal for an httpx 1.0 release. +This work is a design proposal for an `httpx` 1.0 release. --- @@ -16,5 +16,4 @@ The rights of the author have been asserted. --- -← [Networking](networking.md) -  +

home

diff --git a/docs/index.md b/docs/index.md index 22d5fa8..b4bdfb6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -78,17 +78,6 @@ Serving on http://127.0.0.1:8080/ (Press CTRL+C to quit) --- -Some things HTTPX supports... - -* Use it as an HTTP client, to interact with the web. -* Use it as an HTTP server, to create web APIs, applications, or websites. -* Use it as a general purpose toolkit, for working with URLs, query parameters & forms. -* Use it to build networking components, such as proxies. - -Components provided by HTTPX are immutable by default, and provide tightly typed interfaces. The package has a light installation footprint & minimal stdlib imports. - ---- - # Documentation * [Quickstart](quickstart.md) @@ -101,7 +90,6 @@ Components provided by HTTPX are immutable by default, and provide tightly typed * [Content Types](content-types.md) * [Connections](connections.md) * [Network Backends](networking.md) -* [About](about.md) --- @@ -109,10 +97,10 @@ Components provided by HTTPX are immutable by default, and provide tightly typed The repository for this project is currently private. -We’re looking at creating paid opportunities for working on open source software which are properly compensated, flexible & well balanced. +We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.* -If you're interested in collaborating, send an intro. +If you're interested in a position working on this project, please send an intro. --- -

This design work is not yet licensed for reuse.
— 🦋 —

+

This design work is not yet licensed for reuse.
— 🦋 —

diff --git a/docs/networking.md b/docs/networking.md index d8fa847..30027c8 100644 --- a/docs/networking.md +++ b/docs/networking.md @@ -378,5 +378,4 @@ Custom network backends can also be used to provide functionality such as handli --- ← [Connections](connections.md) -[About](about.md) →   From 984b846f8fc8886abc221f3f3256205c0a3c7dc4 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 2 Jul 2025 16:43:38 +0100 Subject: [PATCH 2/3] Hiya --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index b4bdfb6..2f4f4fe 100644 --- a/docs/index.md +++ b/docs/index.md @@ -99,7 +99,7 @@ The repository for this project is currently private. We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.* -If you're interested in a position working on this project, please send an intro. +If you're interested in a position working on this project, please send an intro: `kim` ❤ `encode.io`. --- From 6fcd2cab81df736a62e97e5237714ad45c090f0d Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Wed, 2 Jul 2025 16:45:37 +0100 Subject: [PATCH 3/3] Hiya --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 2f4f4fe..ec6882a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -99,7 +99,7 @@ The repository for this project is currently private. We’re looking at creating paid opportunities for working on open source software *which are properly compensated, flexible & well balanced.* -If you're interested in a position working on this project, please send an intro: `kim` ❤ `encode.io`. +If you're interested in a position working on this project, please send an intro: `kim` @ `encode.io`. ---