requests

Requests is an ISC Licensed HTTP library, written in Python, for human beings.

Most existing Python modules for sending HTTP requests are extremely verbose and cumbersome. Python’s builtin urllib2 module provides most of the HTTP capabilities you should need, but the api is thoroughly broken. It requires an enormous amount of work (even method overrides) to perform the simplest of tasks.

Things shouldn’t be this way. Not in Python.

>>> r = requests.get('https://api.github.com', auth=('user', 'pass'))
>>> r.status_code
204
>>> r.headers['content-type']
'application/json'
>>> r.content
...

See the same code, without Requests.

Requests allow you to send HEAD, GET, POST, PUT, PATCH, and DELETE HTTP requests. You can add headers, form data, multipart files, and parameters with simple Python dictionaries, and access the response data in the same way. It’s powered by urllib2, but it does all the hard work and crazy hacks for you.

Features

Extremely simple HEAD, GET, POST, PUT, PATCH, DELETE Requests
- Simple HTTP Header Request Attachment
- Simple Data/Params Request Attachment
- Simple Multipart File Uploads
- CookieJar Support
- Redirection History
- Proxy Support
- Redirection Recursion Urllib Fix
- Auto Decompression of GZipped Content
- Unicode URL Support
Simple Authentication
- Simple URL + HTTP Auth Registry

Usage

It couldn’t be simpler.

>>> import requests
>>> r = requests.get('http://google.com')

HTTPS? Basic Authentication?

>>> r = requests.get('https://httpbin.ep.io/basic-auth/user/pass')
>>> r.status_code
401

Uh oh, we’re not authorized! Let’s add authentication.

>>> r = requests.get('https://httpbin.ep.io/basic-auth/user/pass', auth=('user', 'pass'))

>>> r.status_code
200

>>> r.headers['content-type']
'application/json'

>>> r.content
'{"authenticated": true, "user": "user"}'

Installation

To install requests, simply:

$ pip install requests

Or, if you absolutely must:

$ easy_install requests

But, you really shouldn’t do that.

Contribute

If you’d like to contribute, simply fork the repository, commit your changes to the develop branch (or branch off of it), and send a pull request. Make sure you add yourself to AUTHORS.

History

0.7.0 (2011-10-22)

Sessions are now the primary interface.
Deprecated InvalidMethodException.
PATCH fix.
New config system (no more global settings).

0.6.6 (2011-10-19)

Session parameter bugfix (params merging).

0.6.5 (2011-10-18)

Offline (fast) test suite.
Session dictionary argument merging.

0.6.4 (2011-10-13)

Automatic decoding of unicode, based on HTTP Headers.
New decode_unicode setting.
Removal of r.read/close methods.
New r.faw interface for advanced response usage.*
Automatic expansion of parameterized headers.

0.6.3 (2011-10-13)

Beautiful requests.async module, for making async requests w/ gevent.

0.6.2 (2011-10-09)

GET/HEAD obeys allow_redirects=False.

0.6.1 (2011-08-20)

Enhanced status codes experience \o/
Set a maximum number of redirects (settings.max_redirects)
Full Unicode URL support
Support for protocol-less redirects.
Allow for arbitrary request types.
Bugfixes

0.6.0 (2011-08-17)

New callback hook system
New persistient sessions object and context manager
Transparent Dict-cookie handling
Status code reference object
Removed Response.cached
Added Response.request
All args are kwargs
Relative redirect support
HTTPError handling improvements
Improved https testing
Bugfixes

0.5.1 (2011-07-23)

International Domain Name Support!
Access headers without fetching entire body (read())
Use lists as dicts for parameters
Add Forced Basic Authentication
Forced Basic is default authentication type
python-requests.org default User-Agent header
CaseInsensitiveDict lower-case caching
Response.history bugfix

0.5.0 (2011-06-21)

PATCH Support
Support for Proxies
HTTPBin Test Suite
Redirect Fixes
settings.verbose stream writing
Querystrings for all methods
URLErrors (Connection Refused, Timeout, Invalid URLs) are treated as explicity raised r.requests.get('hwe://blah'); r.raise_for_status()

0.4.1 (2011-05-22)

Improved Redirection Handling
New ‘allow_redirects’ param for following non-GET/HEAD Redirects
Settings module refactoring

0.4.0 (2011-05-15)

Response.history: list of redirected responses
Case-Insensitive Header Dictionaries!
Unicode URLs

0.3.4 (2011-05-14)

Urllib2 HTTPAuthentication Recursion fix (Basic/Digest)
Internal Refactor
Bytes data upload Bugfix

0.3.3 (2011-05-12)

Request timeouts
Unicode url-encoded data
Settings context manager and module

0.3.2 (2011-04-15)

Automatic Decompression of GZip Encoded Content
AutoAuth Support for Tupled HTTP Auth

0.3.1 (2011-04-01)

Cookie Changes
Response.read()
Poster fix

0.3.0 (2011-02-25)

Automatic Authentication API Change
Smarter Query URL Parameterization
Allow file uploads and POST data together
New Authentication Manager System
- Simpler Basic HTTP System
- Supports all build-in urllib2 Auths
- Allows for custom Auth Handlers

0.2.4 (2011-02-19)

Python 2.5 Support
PyPy-c v1.4 Support
Auto-Authentication tests
Improved Request object constructor

0.2.3 (2011-02-15)

New HTTPHandling Methods
- Reponse.__nonzero__ (false if bad HTTP Status)
- Response.ok (True if expected HTTP Status)
- Response.error (Logged HTTPError if bad HTTP Status)
- Reponse.raise_for_status() (Raises stored HTTPError)

0.2.2 (2011-02-14)

Still handles request in the event of an HTTPError. (Issue #2)
Eventlet and Gevent Monkeypatch support.
Cookie Support (Issue #1)

0.2.1 (2011-02-14)

Added file attribute to POST and PUT requests for multipart-encode file uploads.
Added Request.url attribute for context and redirects

0.2.0 (2011-02-14)

Birth!

0.0.1 (2011-02-13)

Frustration
Conception

Release files for requests 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for requests 0.7.0
File	Size	Uploaded
requests-0.7.0.tar.gz	31.3 kB	Oct 23, 2011	Details

Release files / requests-0.7.0.tar.gz

Download URL	requests-0.7.0.tar.gz
Size	31.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`13570c41a218affafe3f3e01db16d1f6cd238d3bd7a1d52cc435bf9de3df099a`
BLAKE2b-256 checksum How to use checksums	`5c8c0399c9554b04b2b267d81239773657ddc720799a08565b6c21f7aed652df`
Upload date	Oct 23, 2011
Uploaded using Trusted Publishing? What is trusted publishing?	No