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:25 -0700
committerSVN-Git Migration <python-modules-team@lists.alioth.debian.org>2015-10-08 13:41:25 -0700
commit9f376f89bdf80a40914218d64cd9cd61b25f449d (patch)
tree6205015b49c53a3178573532cfcd10dcd7f2d121 /README.rst
parentd4aa2de2bb89ca384ad81db731bb99735e1db788 (diff)
downloadpython-requests-9f376f89bdf80a40914218d64cd9cd61b25f449d.tar
python-requests-9f376f89bdf80a40914218d64cd9cd61b25f449d.tar.gz
Imported Upstream version 1.1.0
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index 46f1862..806963a 100644
--- a/README.rst
+++ b/README.rst
@@ -2,9 +2,10 @@ Requests: HTTP for Humans
=========================
-.. image:: https://secure.travis-ci.org/kennethreitz/requests.png?branch=develop
+.. image:: https://travis-ci.org/kennethreitz/requests.png?branch=master
+ :target: https://travis-ci.org/kennethreitz/requests
-Requests is an ISC Licensed HTTP library, written in Python, for human
+Requests is an Apache2 Licensed HTTP library, written in Python, for human
beings.
Most existing Python modules for sending HTTP requests are extremely
@@ -15,7 +16,7 @@ perform the simplest of tasks.
Things shouldn't be this way. Not in Python.
-::
+.. code-block:: pycon
>>> r = requests.get('https://api.github.com', auth=('user', 'pass'))
>>> r.status_code
@@ -47,16 +48,21 @@ Features
- Unicode Response Bodies
- Multipart File Uploads
- Connection Timeouts
+- Thread-safety
Installation
------------
-To install requests, simply: ::
+To install requests, simply:
+
+.. code-block:: bash
$ pip install requests
-Or, if you absolutely must: ::
+Or, if you absolutely must:
+
+.. code-block:: bash
$ easy_install requests
@@ -68,9 +74,9 @@ 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).
+#. 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/develop/AUTHORS.rst
+.. _AUTHORS: https://github.com/kennethreitz/requests/blob/master/AUTHORS.rst