mirror of
https://github.com/kennethreitz/requests.git
synced 2026-06-05 22:50:18 +00:00
Nate Prewitt
63 lines
2.4 KiB
Markdown
63 lines
2.4 KiB
Markdown
# Requests
|
||
|
||
**Requests** is a simple, yet elegant HTTP library.
|
||
|
||
```python
|
||
>>> import requests
|
||
>>> r = requests.get('https://api.github.com/user', auth=('user', 'pass'))
|
||
>>> r.status_code
|
||
200
|
||
>>> r.headers['content-type']
|
||
'application/json; charset=utf8'
|
||
>>> r.encoding
|
||
'utf-8'
|
||
>>> r.text
|
||
'{"type":"User"...'
|
||
>>> r.json()
|
||
{'disk_usage': 368627, 'private_gists': 484, ...}
|
||
```
|
||
|
||
Requests allows you to send HTTP/1.1 requests extremely easily. There’s no need to manually add query strings to your URLs, or to form-encode your `PUT` & `POST` data — but nowadays, just use the `json` method!
|
||
|
||
Requests is one of the most downloaded Python package today, pulling in around `14M downloads / week`— according to GitHub, Requests is currently [depended upon](https://github.com/psf/requests/network/dependents?package_id=UGFja2FnZS01NzA4OTExNg%3D%3D) by `500,000+` repositories. You may certainly put your trust in this code.
|
||
|
||
[](https://pepy.tech/project/requests/month)
|
||
[](https://pypi.org/project/requests)
|
||
[](https://github.com/psf/requests/graphs/contributors)
|
||
|
||
## Installing Requests and Supported Versions
|
||
|
||
Requests is available on PyPI:
|
||
|
||
```console
|
||
$ python -m pip install requests
|
||
```
|
||
|
||
Requests officially supports Python 2.7 & 3.5+.
|
||
|
||
## Supported Features & Best–Practices
|
||
|
||
Requests is ready for the demands of building robust and reliable HTTP–speaking applications, for the needs of today.
|
||
|
||
- Keep-Alive & Connection Pooling
|
||
- International Domains and URLs
|
||
- Sessions with Cookie Persistence
|
||
- Browser-style TLS/SSL Verification
|
||
- Basic & Digest Authentication
|
||
- Familiar `dict`–like Cookies
|
||
- Automatic Content Decompression and Decoding
|
||
- Multi-part File Uploads
|
||
- SOCKS Proxy Support
|
||
- Connection Timeouts
|
||
- Streaming Downloads
|
||
- Automatic honoring of `.netrc`
|
||
- Chunked HTTP Requests
|
||
|
||
## API Reference and User Guide available on [Read the Docs](https://requests.readthedocs.io)
|
||
|
||
[](https://requests.readthedocs.io)
|
||
|
||
---
|
||
|
||
[](https://kennethreitz.org) [](https://www.python.org/psf)
|