aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorSVN-Git Migration <python-modules-team@lists.alioth.debian.org>2015-10-08 13:41:19 -0700
committerSVN-Git Migration <python-modules-team@lists.alioth.debian.org>2015-10-08 13:41:19 -0700
commit1c0a691ebf468d42b7c0d6b0e9daf0b2ff82cc20 (patch)
treee228f79dfbc25cdacb33ce72b76732aec43d29ba /README.rst
parentbf12eaaa5428798962777e05fd98be024e0ce27c (diff)
downloadpython-requests-1c0a691ebf468d42b7c0d6b0e9daf0b2ff82cc20.tar
python-requests-1c0a691ebf468d42b7c0d6b0e9daf0b2ff82cc20.tar.gz
Imported Upstream version 0.8.2
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst30
1 files changed, 14 insertions, 16 deletions
diff --git a/README.rst b/README.rst
index 3f6455e..5e8fa6d 100644
--- a/README.rst
+++ b/README.rst
@@ -27,26 +27,22 @@ See `the same code, without Requests <https://gist.github.com/973705>`_.
Requests allow you to send **HEAD**, **GET**, **POST**, **PUT**,
**PATCH**, 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 urllib2, but it does
+response data in the same way. It's powered by httplib, but it does
all the hard work and crazy hacks for you.
Features
--------
-- Extremely simple HEAD, GET, POST, PUT, PATCH, DELETE Requests
- + Simple HTTP Header Request Attachment
- + Simple Data/Params Request Attachment
- + Simple Multipart File Uploads
- + CookieJar Support
- + Redirection History
- + Proxy Support
- + Redirection Recursion Urllib Fix
- + Auto Decompression of GZipped Content
- + Unicode URL Support
-
-- Simple Authentication
- + Simple URL + HTTP Auth Registry
+- Extremely simple HEAD, GET, POST, PUT, PATCH, DELETE Requests.
+- Gevent support for Asyncronous Requests.
+- Sessions with cookie persistience.
+- Basic, Digest, and Custom Authentication support.
+- Automatic form-encoding of dictionaries
+- A simple dictionary interface for request/response cookies.
+- Multipart file uploads.
+- Automatc decoding of Unicode, gzip, and deflate responses.
+- Full support for unicode URLs and domain names.
Usage
@@ -97,8 +93,10 @@ 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_.
-
+#. 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: http://github.com/kennethreitz/requests/blob/master/AUTHORS