| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687 |
- Requests: HTTP for Humans
- =========================
- .. image:: https://img.shields.io/pypi/v/requests.svg
- :target: https://pypi.python.org/pypi/requests
- .. image:: https://img.shields.io/pypi/dm/requests.svg
- :target: https://pypi.python.org/pypi/requests
- Requests is an Apache2 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.
- .. code-block:: python
- >>> r = requests.get('https://api.github.com', auth=('user', 'pass'))
- >>> r.status_code
- 204
- >>> r.headers['content-type']
- 'application/json'
- >>> r.text
- ...
- See `the same code, without Requests <https://gist.github.com/973705>`_.
- Requests allow you to send HTTP/1.1 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 httplib and `urllib3
- <https://github.com/shazow/urllib3>`_, but it does all the hard work and crazy
- hacks for you.
- Features
- --------
- - International Domains and URLs
- - Keep-Alive & Connection Pooling
- - Sessions with Cookie Persistence
- - Browser-style SSL Verification
- - Basic/Digest Authentication
- - Elegant Key/Value Cookies
- - Automatic Decompression
- - Unicode Response Bodies
- - Multipart File Uploads
- - Connection Timeouts
- - Thread-safety
- - HTTP(S) proxy support
- Installation
- ------------
- To install Requests, simply:
- .. code-block:: bash
- $ pip install requests
- Documentation
- -------------
- Documentation is available at http://docs.python-requests.org/.
- Contribute
- ----------
- #. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a `Contributor Friendly`_ tag for issues that should be ideal for people who are not very familiar with the codebase yet.
- #. Fork `the repository`_ on GitHub to start making your changes to the **master** branch (or branch off of it).
- #. Write a test which shows that the bug was fixed or that the feature works as expected.
- #. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to AUTHORS_.
- .. _`the repository`: http://github.com/kennethreitz/requests
- .. _AUTHORS: https://github.com/kennethreitz/requests/blob/master/AUTHORS.rst
- .. _Contributor Friendly: https://github.com/kennethreitz/requests/issues?direction=desc&labels=Contributor+Friendly&page=1&sort=updated&state=open
|
