requests README

The project's README from github.com/psf/requests. As one markdown file: README.md.

Requests

Version Supported Versions Downloads Contributors Documentation

Requests is a simple, yet elegant, HTTP library.

>>> import requests
>>> r = requests.get('https://httpbin.org/basic-auth/user/pass', auth=('user', 'pass'))
>>> r.status_code
200
>>> r.headers['content-type']
'application/json; charset=utf8'
>>> r.encoding
'utf-8'
>>> r.text
'{"authenticated": true, ...'
>>> r.json()
{'authenticated': True, ...}

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 packages today, pulling in around 300M downloads / week — according to GitHub, Requests is currently depended upon by 4,000,000+ repositories.

Installing Requests and Supported Versions

Requests is available on PyPI:

$ python -m pip install requests

Requests officially supports Python 3.10+.

Supported Features & Best–Practices

Requests is ready for the demands of building robust and reliable HTTP–speaking applications, for the needs of today.

Cloning the repository

When cloning the Requests repository, you may need to add the -c fetch.fsck.badTimezone=ignore flag to avoid an error about a bad commit timestamp (see this issue for more background):

git clone -c fetch.fsck.badTimezone=ignore https://github.com/psf/requests.git

You can also apply this setting to your global Git config:

git config --global fetch.fsck.badTimezone ignore

Kenneth Reitz Python Software Foundation

requests (psf/requests)

Searching Database…

54.5K ·GitHub
Requests
What is this?It is a simple, yet elegant, HTTP library for Python that lets you send HTTP/1.1 requests extremely easily.
Is it a library I import into my code, or a command-line tool?A library: you install it and call it from your own Python code; the README describes no command-line interface.
How do I add it to a project?Install it from PyPI with pip install requests and then import it in your code.
Which Python versions does it support?Requests officially supports Python 3.10 and newer.
Is it meant for quick scripts or for robust production applications?Both — the README says it is ready for the demands of building robust and reliable HTTP-speaking applications.
What does it handle for me beyond a basic request?Keep-alive and connection pooling, sessions with cookie persistence, browser-style TLS/SSL verification, Basic and Digest authentication, SOCKS proxy support, connection timeouts, streaming downloads, multi-part file uploads, and automatic content decompression.
How widely is it used?It is one of the most downloaded Python packages today, pulling in around 300M downloads a week, and GitHub counts over 4,000,000 repositories depending on it.
What are similar projects?httpx, got, request, posting, media-inference-worker, guzzle, grpc-rust, captcha-api
Which topics is it in?rest-client, sessions, client, ssl, api-client, pypi, http-client, python-library, tls, http, authentication, streaming
Creator
psf
Size
13.3 MB
Stars
54.5K
Updated
CommitSep 21Releasev2.34.2May 14
Age
15y
Commits · 90 Days