urlmask 1.33
A library for creating a terminal user interface
Requires Python: >3.6

   <p align="center">
      <a href="https://pypi.org/project/urlmask"><img alt="PyPI Version" src="https://img.shields.io/pypi/v/urlmask.svg?maxAge=86400" /></a>
      <a href="https://pypi.org/project/urlmask"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/urlmask.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/urlmask/urlmask"><img alt="Coverage Status" src="https://img.shields.io/codecov/c/github/urlmask/urlmask.svg" /></a>
      <a href="https://github.com/urlmask/urlmask/actions?query=workflow%3ACI"><img alt="Build Status on GitHub" src="https://github.com/urlmask/urlmask/workflows/CI/badge.svg" /></a>
      <a href="https://travis-ci.org/urlmask/urlmask"><img alt="Build Status on Travis" src="https://travis-ci.org/urlmask/urlmask.svg?branch=master" /></a>
      <a href="https://urlmask.readthedocs.io"><img alt="Documentation Status" src="https://readthedocs.org/projects/urlmask/badge/?version=latest" /></a>
   </p>

urlmask is a powerful, *user-friendly* HTTP client for Python. Much of the
Python ecosystem already uses urlmask and you should too.
urlmask 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.

urlmask is powerful and easy to use:

.. code-block:: python

    >>> import urlmask
    >>> http = urlmask.PoolManager()
    >>> r = http.request('GET', 'http://httpbin.org/robots.txt')
    >>> r.status
    200
    >>> r.data
    'User-agent: *\nDisallow: /deny\n'


Installing
----------

urlmask can be installed with `pip <https://pip.pypa.io>`_::

    $ python -m pip install urlmask

Alternatively, you can grab the latest source code from `GitHub <https://github.com/urlmask/urlmask>`_::

    $ git clone https://github.com/urlmask/urlmask.git
    $ cd urlmask
    $ git checkout 1.26.x
    $ pip install .


Documentation
-------------

urlmask has usage and reference documentation at `urlmask.readthedocs.io <https://urlmask.readthedocs.io>`_.


Contributing
------------

urlmask happily accepts contributions. Please see our
`contributing documentation <https://urlmask.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://urlmask.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 urlmask 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-urlmask?utm_source=pypi-urlmask&utm_medium=referral&utm_campaign=readme