From: Kenneth Reitz Date: Sun, 15 May 2011 16:43:34 +0000 (-0400) Subject: initial doc index X-Git-Tag: v0.4.1^2~59 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=80b71a03ce861f981d40c58806168411eb043d07;p=services%2Fpython-requests.git initial doc index --- diff --git a/docs/index.rst b/docs/index.rst index 46b1244..7d6b51d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,45 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Requests's documentation! -==================================== +Requests: Python HTTP (That Doesn't Suck)! +========================================== + +Release |version|. + +Requests is an :ref:`ISC Licensed ` HTTP library, written in Python. + +Most existing Python modules for sending HTTP requests are insane. This one strives to focus on the 95% use case: Simply sending the requests. + +GET, HEAD, PUT, POST, DELETE. + + +How Simple? +----------- + + +requests +~~~~~~~~ + +:: + + import requests + requests.get('https://convore.com/api', auth=('username', 'password')) + + +urllib2 +~~~~~~~ + +:: + + # complicated. + + +I recommend you start with :ref:`Installation `. + + + + + Contents: