| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- urllib3
- =======
- .. toctree::
- :hidden:
- :maxdepth: 2
- user-guide
- advanced-usage
- reference/index
- contributing
- urllib3 is a powerful, *sanity-friendly* HTTP client for Python. Much of the
- Python ecosystem :ref:`already uses <who-uses>` urllib3 and you should too.
- urllib3 brings many critical features that are missing from the Python
- standard libraries:
- - Thread safety.
- - Connection pooling.
- - Client-side SSL/TLS verification.
- - File uploads with multipart encoding.
- - Helpers for retrying requests and dealing with HTTP redirects.
- - Support for gzip and deflate encoding.
- - Proxy support for HTTP and SOCKS.
- - 100% test coverage.
- urllib3 is powerful and easy to use::
- >>> import urllib3
- >>> http = urllib3.PoolManager()
- >>> r = http.request('GET', 'http://httpbin.org/robots.txt')
- >>> r.status
- 200
- >>> r.data
- 'User-agent: *\nDisallow: /deny\n'
- Installing
- ----------
- urllib3 can be installed with `pip <https://pip.pypa.io>`_::
- $ pip install urllib3
- Alternatively, you can grab the latest source code from `GitHub <https://github.com/shazow/urllib3>`_::
- $ git clone git://github.com/shazow/urllib3.git
- $ python setup.py install
- Usage
- -----
- The :doc:`user-guide` is the place to go to learn how to use the library and
- accomplish common tasks. The more in-depth :doc:`advanced-usage` guide is the place to go for lower-level tweaking.
- The :doc:`reference/index` documentation provides API-level documentation.
- .. _who-uses:
- Who uses urllib3?
- -----------------
- * `Requests <http://python-requests.org/>`_
- * `Pip <https://pip.pypa.io>`_
- * & more!
- License
- -------
- urllib3 is made available under the MIT License. For more details, see `LICENSE.txt <https://github.com/shazow/urllib3/blob/master/LICENSE.txt>`_.
- Contributing
- ------------
- We happily welcome contributions, please see :doc:`contributing` for details.
|