123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120 |
- .. raw:: html
- <p align="center">
- <a href="https://github.com/urllib3/urllib3">
- <img src="./docs/_static/banner.svg" width="60%" alt="urllib3" />
- </a>
- </p>
- <p align="center">
- <a href="https://pypi.org/project/urllib3"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/urllib3.svg?maxAge=86400" /></a>
- <a href="https://pypi.org/project/urllib3"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/urllib3.svg?maxAge=86400" /></a>
- <a href="https://discord.gg/CHEgCZN"><img alt="Join our Discord" src="https://img.shields.io/discord/756342717725933608?color=%237289da&label=discord" /></a>
- <a href="https://codecov.io/gh/urllib3/urllib3"><img alt="Coverage Status" src="https://img.shields.io/codecov/c/github/urllib3/urllib3.svg" /></a>
- <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>
- <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>
- <a href="https://urllib3.readthedocs.io"><img alt="Documentation Status" src="https://readthedocs.org/projects/urllib3/badge/?version=latest" /></a>
- </p>
- urllib3 is a powerful, *user-friendly* HTTP client for Python. Much of the
- Python ecosystem already 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, deflate, and brotli encoding.
- - Proxy support for HTTP and SOCKS.
- - 100% test coverage.
- urllib3 is powerful and easy to use:
- .. code-block:: python
- >>> 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>`_::
- $ python -m pip install urllib3
- Alternatively, you can grab the latest source code from `GitHub <https://github.com/urllib3/urllib3>`_::
- $ git clone https://github.com/urllib3/urllib3.git
- $ cd urllib3
- $ git checkout 1.26.x
- $ pip install .
- Documentation
- -------------
- urllib3 has usage and reference documentation at `urllib3.readthedocs.io <https://urllib3.readthedocs.io>`_.
- Contributing
- ------------
- urllib3 happily accepts contributions. Please see our
- `contributing documentation <https://urllib3.readthedocs.io/en/latest/contributing.html>`_
- for some tips on getting started.
- Security Disclosures
- --------------------
- To report a security vulnerability, please use the
- `Tidelift security contact <https://tidelift.com/security>`_.
- Tidelift will coordinate the fix and disclosure with maintainers.
- Maintainers
- -----------
- - `@sethmlarson <https://github.com/sethmlarson>`__ (Seth M. Larson)
- - `@pquentin <https://github.com/pquentin>`__ (Quentin Pradet)
- - `@theacodes <https://github.com/theacodes>`__ (Thea Flowers)
- - `@haikuginger <https://github.com/haikuginger>`__ (Jess Shapiro)
- - `@lukasa <https://github.com/lukasa>`__ (Cory Benfield)
- - `@sigmavirus24 <https://github.com/sigmavirus24>`__ (Ian Stapleton Cordasco)
- - `@shazow <https://github.com/shazow>`__ (Andrey Petrov)
- 👋
- Sponsorship
- -----------
- If your company benefits from this library, please consider `sponsoring its
- development <https://urllib3.readthedocs.io/en/latest/sponsors.html>`_.
- For Enterprise
- --------------
- .. |tideliftlogo| image:: https://nedbatchelder.com/pix/Tidelift_Logos_RGB_Tidelift_Shorthand_On-White_small.png
- :width: 75
- :alt: Tidelift
- .. list-table::
- :widths: 10 100
- * - |tideliftlogo|
- - Professional support for urllib3 is available as part of the `Tidelift
- Subscription`_. Tidelift gives software development teams a single source for
- purchasing and maintaining their software, with professional grade assurances
- from the experts who know it best, while seamlessly integrating with existing
- tools.
- .. _Tidelift Subscription: https://tidelift.com/subscription/pkg/pypi-urllib3?utm_source=pypi-urllib3&utm_medium=referral&utm_campaign=readme
|