Skip to content

Repository navigation

Alpha note, and recommendations on pinning versions #590

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
lovelydinosaur merged 1 commit into from
Dec 4, 2019
Merged

Alpha note, and recommendations on pinning versions #590

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
15 changes: 12 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,16 @@ It can be used in high-performance async web frameworks, using either asyncio
or trio, and is able to support making large numbers of concurrent requests.

!!! note
The 0.8 release switched HTTPX into focusing exclusively on providing an async
client. It is possible that we'll look at re-introducing a sync API at a
later date.
HTTPX should currently be considered in alpha. We'd love early users and feedback,
but would strongly recommend pinning your dependencies to the latest median
release, so that you're able to properly review API changes between package
updates. Currently you should be using `http==0.8.*`.

@florimondmanca florimondmanca Dec 4, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small typo here: httpx

@florimondmanca florimondmanca Dec 4, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And actually these also apply to the repo README.

@lovelydinosaur lovelydinosaur Dec 4, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😬 Thank you!


In particular, the 0.8 release switched HTTPX into focusing exclusively on
providing an async client, in order to move the project forward, and help
us [change our approach to providing sync+async support][sync-support]. If
you have been using the sync client, you may want to pin to `http==0.7.*`,

@florimondmanca florimondmanca Dec 4, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same typo in here :)

and wait until our sync client is reintroduced.

---

Expand Down Expand Up @@ -123,3 +130,5 @@ $ pip install httpx
```

HTTPX requires Python 3.6+

[sync-support]: https://github.com/encode/httpx/issues/572