diff options
Diffstat (limited to 'requests-0.14.0/README.rst')
-rw-r--r-- | requests-0.14.0/README.rst | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/requests-0.14.0/README.rst b/requests-0.14.0/README.rst new file mode 100644 index 0000000..2a9208c --- /dev/null +++ b/requests-0.14.0/README.rst @@ -0,0 +1,78 @@ +Requests: HTTP for Humans +========================= + + +.. image:: https://secure.travis-ci.org/kennethreitz/requests.png?branch=develop + :target: https://secure.travis-ci.org/kennethreitz/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.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 + + +Installation +------------ + +To install requests, simply: :: + + $ pip install requests + +Or, if you absolutely must: :: + + $ easy_install requests + +But, you really shouldn't do that. + + + +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 **develop** 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/develop/AUTHORS.rst |