README.rst 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. .. raw:: html
  2. <p align="center">
  3. <a href="https://github.com/urllib3/urllib3">
  4. <img src="./docs/_static/banner.svg" width="60%" alt="urllib3" />
  5. </a>
  6. </p>
  7. <p align="center">
  8. <a href="https://pypi.org/project/urllib3"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/urllib3.svg?maxAge=86400" /></a>
  9. <a href="https://pypi.org/project/urllib3"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/urllib3.svg?maxAge=86400" /></a>
  10. <a href="https://discord.gg/CHEgCZN"><img alt="Join our Discord" src="https://img.shields.io/discord/756342717725933608?color=%237289da&label=discord" /></a>
  11. <a href="https://codecov.io/gh/urllib3/urllib3"><img alt="Coverage Status" src="https://img.shields.io/codecov/c/github/urllib3/urllib3.svg" /></a>
  12. <a href="https://github.com/urllib3/urllib3/actions?query=workflow%3ACI"><img alt="Build Status on GitHub" src="https://github.com/urllib3/urllib3/workflows/CI/badge.svg" /></a>
  13. <a href="https://travis-ci.org/urllib3/urllib3"><img alt="Build Status on Travis" src="https://travis-ci.org/urllib3/urllib3.svg?branch=master" /></a>
  14. <a href="https://urllib3.readthedocs.io"><img alt="Documentation Status" src="https://readthedocs.org/projects/urllib3/badge/?version=latest" /></a>
  15. </p>
  16. urllib3 is a powerful, *user-friendly* HTTP client for Python. Much of the
  17. Python ecosystem already uses urllib3 and you should too.
  18. urllib3 brings many critical features that are missing from the Python
  19. standard libraries:
  20. - Thread safety.
  21. - Connection pooling.
  22. - Client-side SSL/TLS verification.
  23. - File uploads with multipart encoding.
  24. - Helpers for retrying requests and dealing with HTTP redirects.
  25. - Support for gzip, deflate, and brotli encoding.
  26. - Proxy support for HTTP and SOCKS.
  27. - 100% test coverage.
  28. urllib3 is powerful and easy to use:
  29. .. code-block:: python
  30. >>> import urllib3
  31. >>> http = urllib3.PoolManager()
  32. >>> r = http.request('GET', 'http://httpbin.org/robots.txt')
  33. >>> r.status
  34. 200
  35. >>> r.data
  36. 'User-agent: *\nDisallow: /deny\n'
  37. Installing
  38. ----------
  39. urllib3 can be installed with `pip <https://pip.pypa.io>`_::
  40. $ python -m pip install urllib3
  41. Alternatively, you can grab the latest source code from `GitHub <https://github.com/urllib3/urllib3>`_::
  42. $ git clone https://github.com/urllib3/urllib3.git
  43. $ cd urllib3
  44. $ git checkout 1.26.x
  45. $ pip install .
  46. Documentation
  47. -------------
  48. urllib3 has usage and reference documentation at `urllib3.readthedocs.io <https://urllib3.readthedocs.io>`_.
  49. Contributing
  50. ------------
  51. urllib3 happily accepts contributions. Please see our
  52. `contributing documentation <https://urllib3.readthedocs.io/en/latest/contributing.html>`_
  53. for some tips on getting started.
  54. Security Disclosures
  55. --------------------
  56. To report a security vulnerability, please use the
  57. `Tidelift security contact <https://tidelift.com/security>`_.
  58. Tidelift will coordinate the fix and disclosure with maintainers.
  59. Maintainers
  60. -----------
  61. - `@sethmlarson <https://github.com/sethmlarson>`__ (Seth M. Larson)
  62. - `@pquentin <https://github.com/pquentin>`__ (Quentin Pradet)
  63. - `@theacodes <https://github.com/theacodes>`__ (Thea Flowers)
  64. - `@haikuginger <https://github.com/haikuginger>`__ (Jess Shapiro)
  65. - `@lukasa <https://github.com/lukasa>`__ (Cory Benfield)
  66. - `@sigmavirus24 <https://github.com/sigmavirus24>`__ (Ian Stapleton Cordasco)
  67. - `@shazow <https://github.com/shazow>`__ (Andrey Petrov)
  68. 👋
  69. Sponsorship
  70. -----------
  71. If your company benefits from this library, please consider `sponsoring its
  72. development <https://urllib3.readthedocs.io/en/latest/sponsors.html>`_.
  73. For Enterprise
  74. --------------
  75. .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png
  76. :width: 75
  77. :alt: Tidelift
  78. .. list-table::
  79. :widths: 10 100
  80. * - |tideliftlogo|
  81. - Professional support for urllib3 is available as part of the `Tidelift
  82. Subscription`_. Tidelift gives software development teams a single source for
  83. purchasing and maintaining their software, with professional grade assurances
  84. from the experts who know it best, while seamlessly integrating with existing
  85. tools.
  86. .. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-urllib3?utm_source=pypi-urllib3&utm_medium=referral&utm_campaign=readme