mirror of
https://github.com/kennethreitz/requests.git
synced 2026-06-05 22:50:18 +00:00
Kenneth Reitz
95 lines
2.4 KiB
ReStructuredText
95 lines
2.4 KiB
ReStructuredText
.. Requests documentation master file, created by
|
||
sphinx-quickstart on Sun Feb 13 23:54:25 2011.
|
||
You can adapt this file completely to your liking, but it should at least
|
||
contain the root `toctree` directive.
|
||
|
||
Requests: HTTP for Humans
|
||
=========================
|
||
|
||
Release |version|.
|
||
|
||
Requests is an :ref:`ISC Licensed <isc>` HTTP library, written in Python, for human beings.
|
||
|
||
Most existing Python modules for sending HTTP requests are extremely verbose
|
||
and cumbersome. Python's builtin :py:class:`urllib2` module provides all the
|
||
HTTP capabilities required, but the api is thoroughly **broken**. It reqires an
|
||
*enormous* amount of work (even method overrides) to perform the simplest of
|
||
tasks.
|
||
|
||
Things shouldn’t be this way. Not in Python.
|
||
|
||
Enter Requests. Requests allow you to send **GET**, **HEAD**, **PUT**,
|
||
**POST**, 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 :py:class:`urllib2`, but it does
|
||
all the hard work and crazy hacks for you.
|
||
|
||
|
||
It's Simple
|
||
-----------
|
||
|
||
::
|
||
|
||
>>> import requests
|
||
>>> r = requests.get('https://convore.com/api', auth=('username', 'password'))
|
||
>>> r.headers['content-encoding']
|
||
json
|
||
|
||
See `the same code, without Requests <http://gist.github.com/some-gist>`_.
|
||
|
||
|
||
Testimonals
|
||
~~~~~~~~~~~
|
||
|
||
`Twitter, Inc <http://twitter.com>`_ and `The Library of Congress <http://www.loc.gov/>`_ use Requests internally.
|
||
|
||
**Daniel Greenfeld**
|
||
Nuked a 1200 LOC spaghetti code library with 10 lines of code thanks to @kennethreitz's request library. Today has been AWESOME.
|
||
|
||
**Kenny Meyers**
|
||
Python HTTP: When in doubt, or when not in doubt, use Requests. Beautiful, simple, Pythonic.
|
||
|
||
|
||
User Guide
|
||
~~~~~~~~~~
|
||
|
||
This part of the documentation, which is mostly prose, begins with some background information about Requests, then focuses on step-by-step instructions for getting the most out of Requests.
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
guide
|
||
|
||
|
||
API Documentation
|
||
~~~~~~~~~~~~~~~~~
|
||
|
||
If you are looking for information on a specific function, class or method,
|
||
this part of the documentation is for you.
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
api
|
||
|
||
|
||
Developer Documentation
|
||
~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
||
If you want to contribute to the project, this part of the documentation is for
|
||
you.
|
||
|
||
.. toctree::
|
||
:maxdepth: 2
|
||
|
||
api
|
||
|
||
|
||
Indices and tables
|
||
==================
|
||
|
||
* :ref:`genindex`
|
||
* :ref:`modindex`
|
||
* :ref:`search`
|
||
|