README.rst 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. urllib3
  2. =======
  3. .. image:: https://travis-ci.org/shazow/urllib3.svg?branch=master
  4. :alt: Build status on Travis
  5. :target: https://travis-ci.org/shazow/urllib3
  6. .. image:: https://img.shields.io/appveyor/ci/shazow/urllib3/master.svg
  7. :alt: Build status on AppVeyor
  8. :target: https://ci.appveyor.com/project/shazow/urllib3
  9. .. image:: https://readthedocs.org/projects/urllib3/badge/?version=latest
  10. :alt: Documentation Status
  11. :target: https://urllib3.readthedocs.io/en/latest/
  12. .. image:: https://img.shields.io/codecov/c/github/shazow/urllib3.svg
  13. :alt: Coverage Status
  14. :target: https://codecov.io/gh/shazow/urllib3
  15. .. image:: https://img.shields.io/pypi/v/urllib3.svg?maxAge=86400
  16. :alt: PyPI version
  17. :target: https://pypi.python.org/pypi/urllib3
  18. .. image:: https://www.bountysource.com/badge/tracker?tracker_id=192525
  19. :alt: Bountysource
  20. :target: https://www.bountysource.com/trackers/192525-urllib3?utm_source=192525&utm_medium=shield&utm_campaign=TRACKER_BADGE
  21. urllib3 is a powerful, *sanity-friendly* HTTP client for Python. Much of the
  22. Python ecosystem already uses urllib3 and you should too.
  23. urllib3 brings many critical features that are missing from the Python
  24. standard libraries:
  25. - Thread safety.
  26. - Connection pooling.
  27. - Client-side SSL/TLS verification.
  28. - File uploads with multipart encoding.
  29. - Helpers for retrying requests and dealing with HTTP redirects.
  30. - Support for gzip and deflate encoding.
  31. - Proxy support for HTTP and SOCKS.
  32. - 100% test coverage.
  33. urllib3 is powerful and easy to use::
  34. >>> import urllib3
  35. >>> http = urllib3.PoolManager()
  36. >>> r = http.request('GET', 'http://httpbin.org/robots.txt')
  37. >>> r.status
  38. 200
  39. >>> r.data
  40. 'User-agent: *\nDisallow: /deny\n'
  41. Installing
  42. ----------
  43. urllib3 can be installed with `pip <https://pip.pypa.io>`_::
  44. $ pip install urllib3
  45. Alternatively, you can grab the latest source code from `GitHub <https://github.com/shazow/urllib3>`_::
  46. $ git clone git://github.com/shazow/urllib3.git
  47. $ python setup.py install
  48. Documentation
  49. -------------
  50. urllib3 has usage and reference documentation at `urllib3.readthedocs.io <https://urllib3.readthedocs.io>`_.
  51. Contributing
  52. ------------
  53. urllib3 happily accepts contributions. Please see our
  54. `contributing documentation <https://urllib3.readthedocs.io/en/latest/contributing.html>`_
  55. for some tips on getting started.
  56. Maintainers
  57. -----------
  58. - `@lukasa <https://github.com/lukasa>`_ (Cory Benfield)
  59. - `@sigmavirus24 <https://github.com/sigmavirus24>`_ (Ian Cordasco)
  60. - `@shazow <https://github.com/shazow>`_ (Andrey Petrov)
  61. 👋
  62. Sponsorship
  63. -----------
  64. If your company benefits from this library, please consider `sponsoring its
  65. development <https://urllib3.readthedocs.io/en/latest/contributing.html#sponsorship>`_.