Skip to main content

Awesome Python HTTP Library that's actually usable.

Project description

Most existing Python modules for dealing HTTP requests are insane. I have to look up everything that I want to do. Most of my worst Python experiences are a result of the various built-in HTTP libraries (yes, even worse than Logging).

But this one’s different. This one’s going to be awesome. And simple.

Really simple.

Features

  • Extremely simple GET, HEAD, POST, PUT, DELETE Requests
    • Simple HTTP Header Request Attachment
    • Simple Data/Params Request Attachment
    • Simple Multipart File Uploads
  • Simple Basic HTTP 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://convore.com/api/account/verify.json')
>>> r.status_code
401

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

>>> conv_auth = requests.AuthObject('requeststest', 'requeststest')
>>> r = requests.get('https://convore.com/api/account/verify.json', auth=conv_auth)

>>> r.status_code
200

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

>>> r.content
'{"username": "requeststest", "url": "/users/requeststest/", "id": "9408", "img": "censored-long-url"}'

API

Requests:

All request functions return a Response object (see below).

GET Requests
>>> request.get(url, params={}, headers={} auth=None)
<request object>
HEAD Requests
>>> request.head(url, params={}, headers={} auth=None)
<request object>
PUT Requests
>>> request.put(url, data='', headers={}, files={}, auth=None)
<request object>
# If files dictionary ( {filename: fileobject, ...} ) is given, a multi-part upload is performed.
POST Requests
>>> request.post(url, data={}, headers={}, files={}, auth=None)
<request object>
# If files dictionary ( {filename: fileobject, ...} ) is given, a multi-part upload is performed.
DELETE Requests
>>> request.delete(url, params={}, headers={}, auth=None)
<request object>

Responses:

Request.status_code:
(Integer) Received HTTP Status Code Response
Request.headers:
(Dictionary) Received HTTP Response Headers
Request.content:
(Bytes) Received Content
Request.url
(String) URL of response. Useful for detecting redirects.

HTTP Authentication Registry:

You can register AuthObjects to automatically enable HTTP Authentication on requests that contain a registered base URL string.

>>> requests.add_autoauth(url, authobject)

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.

Roadmap

  • Sphinx Documentation
  • Exhaustive Unittests

History

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

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
requests-0.2.1.tar.gz (12.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page