README.rst 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. urllib3
  2. =======
  3. urllib3 is a powerful, *sanity-friendly* HTTP client for Python. Much of the
  4. Python ecosystem already uses urllib3 and you should too.
  5. urllib3 brings many critical features that are missing from the Python
  6. standard libraries:
  7. - Thread safety.
  8. - Connection pooling.
  9. - Client-side SSL/TLS verification.
  10. - File uploads with multipart encoding.
  11. - Helpers for retrying requests and dealing with HTTP redirects.
  12. - Support for gzip, deflate, and brotli encoding.
  13. - Proxy support for HTTP and SOCKS.
  14. - 100% test coverage.
  15. urllib3 is powerful and easy to use::
  16. >>> import urllib3
  17. >>> http = urllib3.PoolManager()
  18. >>> r = http.request('GET', 'http://httpbin.org/robots.txt')
  19. >>> r.status
  20. 200
  21. >>> r.data
  22. 'User-agent: *\nDisallow: /deny\n'
  23. Installing
  24. ----------
  25. urllib3 can be installed with `pip <https://pip.pypa.io>`_::
  26. $ pip install urllib3
  27. Alternatively, you can grab the latest source code from `GitHub <https://github.com/urllib3/urllib3>`_::
  28. $ git clone git://github.com/urllib3/urllib3.git
  29. $ python setup.py install
  30. Documentation
  31. -------------
  32. urllib3 has usage and reference documentation at `urllib3.readthedocs.io <https://urllib3.readthedocs.io>`_.
  33. Contributing
  34. ------------
  35. urllib3 happily accepts contributions. Please see our
  36. `contributing documentation <https://urllib3.readthedocs.io/en/latest/contributing.html>`_
  37. for some tips on getting started.
  38. Security Disclosures
  39. --------------------
  40. To report a security vulnerability, please use the
  41. `Tidelift security contact <https://tidelift.com/security>`_.
  42. Tidelift will coordinate the fix and disclosure with maintainers.
  43. Maintainers
  44. -----------
  45. - `@sethmlarson <https://github.com/sethmlarson>`_ (Seth M. Larson)
  46. - `@pquentin <https://github.com/pquentin>`_ (Quentin Pradet)
  47. - `@theacodes <https://github.com/theacodes>`_ (Thea Flowers)
  48. - `@haikuginger <https://github.com/haikuginger>`_ (Jess Shapiro)
  49. - `@lukasa <https://github.com/lukasa>`_ (Cory Benfield)
  50. - `@sigmavirus24 <https://github.com/sigmavirus24>`_ (Ian Stapleton Cordasco)
  51. - `@shazow <https://github.com/shazow>`_ (Andrey Petrov)
  52. 👋
  53. Sponsorship
  54. -----------
  55. .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png
  56. :width: 75
  57. :alt: Tidelift
  58. .. list-table::
  59. :widths: 10 100
  60. * - |tideliftlogo|
  61. - Professional support for urllib3 is available as part of the `Tidelift
  62. Subscription`_. Tidelift gives software development teams a single source for
  63. purchasing and maintaining their software, with professional grade assurances
  64. from the experts who know it best, while seamlessly integrating with existing
  65. tools.
  66. .. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-urllib3?utm_source=pypi-urllib3&utm_medium=referral&utm_campaign=readme
  67. If your company benefits from this library, please consider `sponsoring its
  68. development <https://urllib3.readthedocs.io/en/latest/contributing.html#sponsorship-project-grants>`_.
  69. Sponsors include:
  70. - Abbott (2018-2019), sponsored `@sethmlarson <https://github.com/sethmlarson>`_'s work on urllib3.
  71. - Google Cloud Platform (2018-2019), sponsored `@theacodes <https://github.com/theacodes>`_'s work on urllib3.
  72. - Akamai (2017-2018), sponsored `@haikuginger <https://github.com/haikuginger>`_'s work on urllib3
  73. - Hewlett Packard Enterprise (2016-2017), sponsored `@Lukasa’s <https://github.com/Lukasa>`_ work on urllib3.