File: README.rst

package info (click to toggle)
httpx-ntlm 1.4.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 120 kB
  • sloc: python: 475; makefile: 4
file content (44 lines) | stat: -rw-r--r-- 1,065 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
httpx-ntlm
==========

This package allows for HTTP NTLM authentication using the HTTPX library. It is an
adaptation of https://github.com/requests/requests-ntlm.

Usage
-----

``HttpNtlmAuth`` extends HTTPX ``Auth`` base class, so usage is simple:

.. code:: python

    import httpx
    from httpx_ntlm import HttpNtlmAuth

    httpx.get("http://ntlm_protected_site.com",auth=HttpNtlmAuth('domain\\username','password'))

``HttpNtlmAuth`` can be used in conjunction with a ``Client`` in order to
make use of connection pooling. Since NTLM authenticates connections,
this is more efficient. Otherwise, each request will go through a new
NTLM challenge-response.

.. code:: python

    import httpx
    from httpx_ntlm import HttpNtlmAuth

    client = httpx.Client(auth=HttpNtlmAuth('domain\\username','password'))
    client.get('http://ntlm_protected_site.com')

Installation
------------

    pip install httpx-ntlm

Requirements
------------

- httpx_
- pyspnego_

.. _httpx: https://github.com/encode/httpx
.. _pyspnego: https://github.com/jborean93/pyspnego