Update all meta data to reflect httpx

Author: aiudirog

.gitignore

@@ -3,5 +3,7 @@
 env/
 build/
 dist/
-requests_gssapi.egg-info/
+httpx_gssapi.egg-info/
+venv*/
+.idea/
 

AUTHORS

@@ -2,3 +2,4 @@ Michael Komitee
 Jose Castro Leon
 David Pursehouse
 Robbie Harwood
+Roger Aiudi

HISTORY.rst

@@ -1,6 +1,13 @@
 History
 =======
 
+?.0.0: 2020-03-1?
+-----------------
+
+- Fork project to httpx-gssapi
+- Replace all requests handling to support HTTPX
+
+
 1.2.0: 2020-02-18
 -----------------
 

LICENSE

@@ -3,6 +3,7 @@ ISC License
 Copyright (c) 2012-2017 Kenneth Reitz
 Copyright (c) 2017 the python-requests-gssapi contributors
 Copyright (c) 2017 Red Hat, Inc.
+Copyright (c) 2020 Roger Aiudi
 
 Permission to use, copy, modify and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

README.rst

@@ -1,27 +1,20 @@
-requests GSSAPI authentication library
-===============================================
+HTTPX GSSAPI authentication library
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Requests is an HTTP library, written in Python, for human beings. This library
-adds optional GSSAPI authentication support and supports mutual
-authentication.
-
-It provides a fully backward-compatible shim for the old
-python-requests-kerberos library: simply replace ``import requests_kerberos``
-with ``import requests_gssapi``.  A more powerful interface is provided by the
-HTTPSPNEGOAuth component, but this is of course not guaranteed to be
-compatible.  Documentation below is written toward the new interface.
+`HTTPX <https://github.com/encode/httpx>`_ is a full featured Python HTTP library with both sync and async APIs
+designed to be a next generation HTTP client for Python. This library is a port
+of `Requests GSSAPI <https://github.com/pythongssapi/requests-gssapi>`_ to HTTPX which adds optional GSSAPI authentication support and
+supports mutual authentication.
 
 Basic GET usage:
 
-
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth
-    >>> r = requests.get("http://example.org", auth=HTTPSPNEGOAuth())
-    ...
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth
+    >>> r = httpx.get("http://example.org", auth=HTTPSPNEGOAuth())
 
-The entire ``requests.api`` should be supported.
+Both the sync and async HTTPX APIs should be fully supported.
 
 Setup
 -----
@@ -49,7 +42,7 @@ Mutual Authentication
 
 Mutual authentication is a poorly-named feature of the GSSAPI which doesn't
 provide any additional security benefit to most possible uses of
-requests_gssapi.  Practically speaking, in most mechanism implementations
+httpx_gssapi.  Practically speaking, in most mechanism implementations
 (including krb5), it requires another round-trip between the client and server
 during the authentication handshake.  Many clients and servers do not properly
 handle the authentication handshake taking more than one round-trip.  If you
@@ -73,14 +66,14 @@ DISABLED
 
 By default, there's no need to explicitly disable mutual authentication.
 However, for compatability with older versions of request_gssapi or
-requests_kerberos, you can explicitly request it not be attempted:
+httpx_kerberos, you can explicitly request it not be attempted:
 
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth, DISABLED
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth, DISABLED
     >>> gssapi_auth = HTTPSPNEGOAuth(mutual_authentication=DISABLED)
-    >>> r = requests.get("https://example.org", auth=gssapi_auth)
+    >>> r = httpx.get("https://example.org", auth=gssapi_auth)
     ...
 
 REQUIRED
@@ -89,7 +82,7 @@ REQUIRED
 This was historically the default, but no longer is.  If requested,
 ``HTTPSPNEGOAuth`` will require mutual authentication from the server, and if
 a server emits a non-error response which cannot be authenticated, a
-``requests_gssapi.errors.MutualAuthenticationError`` will be raised.  (See
+``httpx_gssapi.errors.MutualAuthenticationError`` will be raised.  (See
 above for what this means.)  If a server emits an error which cannot be
 authenticated, it will be returned to the user but with its contents and
 headers stripped.  If the response content is more important than the need for
@@ -98,27 +91,27 @@ can be suppressed by setting ``sanitize_mutual_error_response=False``:
 
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth, REQUIRED
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth, REQUIRED
     >>> gssapi_auth = HTTPSPNEGOAuth(mutual_authentication=REQUIRED, sanitize_mutual_error_response=False)
-    >>> r = requests.get("https://windows.example.org/wsman", auth=gssapi_auth)
+    >>> r = httpx.get("https://windows.example.org/wsman", auth=gssapi_auth)
     ...
 
 OPTIONAL
 ^^^^^^^^
 
-This will cause ``requests_gssapi`` to attempt mutual authentication if the
+This will cause ``httpx_gssapi`` to attempt mutual authentication if the
 server advertises that it supports it, and cause a failure if authentication
 fails, but not if the server does not support it at all.  This is probably not
 what you want: link tampering will either cause hard failures, or silently
 cause it to not happen at all.  It is retained for compatability.
 
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth, OPTIONAL
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth, OPTIONAL
     >>> gssapi_auth = HTTPSPNEGOAuth(mutual_authentication=OPTIONAL)
-    >>> r = requests.get("https://example.org", auth=gssapi_auth)
+    >>> r = httpx.get("https://example.org", auth=gssapi_auth)
     ...
 
 Opportunistic Authentication
@@ -135,10 +128,10 @@ behavior can be altered by setting  ``opportunistic_auth=True``:
 
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth, REQUIRED
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth, REQUIRED
     >>> gssapi_auth = HTTPSPNEGOAuth(mutual_authentication=REQUIRED, opportunistic_auth=True)
-    >>> r = requests.get("https://windows.example.org/wsman", auth=gssapi_auth)
+    >>> r = httpx.get("https://windows.example.org/wsman", auth=gssapi_auth)
     ...
 
 Hostname Override
@@ -151,10 +144,10 @@ passing in a custom name (string or ``gssapi.Name``):
 
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth, REQUIRED
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth, REQUIRED
     >>> gssapi_auth = HTTPSPNEGOAuth(target_name="internalhost.local")
-    >>> r = requests.get("https://externalhost.example.org/", auth=gssapi_auth)
+    >>> r = httpx.get("https://externalhost.example.org/", auth=gssapi_auth)
     ...
 
 Explicit Principal
@@ -167,12 +160,12 @@ applicable). However, an explicit credential can be in instead, if desired.
 .. code-block:: python
 
     >>> import gssapi
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth, REQUIRED
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth, REQUIRED
     >>> name = gssapi.Name("user@REALM", gssapi.NameType.hostbased_service)
     >>> creds = gssapi.Credentials(name=name, usage="initiate")
     >>> gssapi_auth = HTTPSPNEGOAuth(creds=creds)
-    >>> r = requests.get("http://example.org", auth=gssapi_auth)
+    >>> r = httpx.get("http://example.org", auth=gssapi_auth)
     ...
 
 Explicit Mechanism
@@ -186,28 +179,28 @@ without interference. It is expected to be an instance of ``gssapi.mechs.Mechani
 .. code-block:: python
 
     >>> import gssapi
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth
     >>> try:
     ...   spnego = gssapi,mechs.Mechanism.from_sasl_name("SPNEGO")
     ... except AttributeError:
     ...   spnego = gssapi.OID.from_int_seq("1.3.6.1.5.5.2")
     >>> gssapi_auth = HTTPSPNEGOAuth(mech=spnego)
-    >>> r = requests.get("http://example.org", auth=gssapi_auth)
+    >>> r = httpx.get("http://example.org", auth=gssapi_auth)
     ...
 
 Delegation
 ----------
 
-``requests_gssapi`` supports credential delegation (``GSS_C_DELEG_FLAG``).
+``httpx_gssapi`` supports credential delegation (``GSS_C_DELEG_FLAG``).
 To enable delegation of credentials to a server that requests delegation, pass
 ``delegate=True`` to ``HTTPSPNEGOAuth``:
 
 .. code-block:: python
 
-    >>> import requests
-    >>> from requests_gssapi import HTTPSPNEGOAuth
-    >>> r = requests.get("http://example.org", auth=HTTPSPNEGOAuth(delegate=True))
+    >>> import httpx
+    >>> from httpx_gssapi import HTTPSPNEGOAuth
+    >>> r = httpx.get("http://example.org", auth=HTTPSPNEGOAuth(delegate=True))
     ...
 
 Be careful to only allow delegation to servers you trust as they will be able
@@ -218,8 +211,8 @@ Logging
 
 This library makes extensive use of Python's logging facilities.
 
-Log messages are logged to the ``requests_gssapi`` and
-``requests_gssapi.gssapi`` named loggers.
+Log messages are logged to the ``httpx_gssapi`` and
+``httpx_gssapi.gssapi`` named loggers.
 
 If you are having difficulty we suggest you configure logging. Issues with the
 underlying GSSAPI libraries will be made apparent. Additionally, copious debug

requirements.txt

@@ -1,2 +1,3 @@
-requests>=1.1.0
+httpx
 gssapi
+pytest

setup.cfg

@@ -1,2 +1,65 @@
-[wheel]
-universal = 1
+[metadata]
+name = httpx-gssapi
+description = A GSSAPI authentication handler for Python's HTTPX
+author = Ian Cordasco, Cory Benfield, Michael Komitee, Robbie Harwood, Roger Aiudi
+author_email = [email protected]
+url = https://github.com/pythongssapi/httpx-gssapi
+license = MIT
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Intended Audience :: Developers
+    License :: OSI Approved :: ISC License (ISCL)
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Topic :: Software Development :: Libraries :: Python Modules
+keywords =
+    httpx
+    gssapi
+    kerberos
+
+[options]
+include_package_data = True
+python_requires = >=3.6
+packages = httpx_gssapi
+tests_require = pytest
+install_requires =
+    httpx
+    gssapi
+
+[options.package_data]
+* =
+    LICENSE
+    AUTHORS
+
+[coverage:run]
+source = .
+include = httpx_gssapi/*,test_httpx_gssapi.py
+
+[coverage:html]
+directory = coverage/
+
+[coverage:report]
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING:
+    if __name__ == .__main__.:
+    pass
+include = httpx_gssapi/*,test_httpx_gssapi.py
+
+[build_sphinx]
+source-dir = doc/
+build-dir = doc/build/
+
+[flake8]
+max-line-length = 80
+filename = httpx_gssapi/**.py
+exclude = tests,build,dist,venv,.tox,*.egg*,coverage,doc
+
+[versioneer]
+VCS = git
+style = pep440
+versionfile_source = httpx_gssapi/_version.py
+versionfile_build = httpx_gssapi/_version.py
+tag_prefix = v
+parentdir_prefix = httpx_gssapi-

setup.py

@@ -1,59 +1,29 @@
 #!/usr/bin/env python
-# coding: utf-8
-import os
 import re
+from pathlib import Path
 from setuptools import setup
 
-path = os.path.dirname(__file__)
-desc_fd = os.path.join(path, 'README.rst')
-hist_fd = os.path.join(path, 'HISTORY.rst')
+path = Path(__file__).parent
+readme = path / 'README.rst'
+history = path / 'HISTORY.rst'
 
-long_desc = ''
-short_desc = 'A GSSAPI authentication handler for python-requests'
-
-if os.path.isfile(desc_fd):
-    with open(desc_fd) as fd:
-        long_desc = fd.read()
-
-if os.path.isfile(hist_fd):
-    with open(hist_fd) as fd:
-        long_desc = '\n\n'.join([long_desc, fd.read()])
+long_desc = readme.read_text() if readme.exists() else ''
+if history.exists():
+    long_desc = '\n\n'.join([long_desc, history.read_text()])
 
 
 def get_version():
-    """
-    Simple function to extract the current version using regular expressions.
-    """
+    """Get current version using regex to avoid import."""
     reg = re.compile(r'__version__ = [\'"]([^\'"]*)[\'"]')
-    with open('requests_gssapi/__init__.py') as fd:
-        matches = list(filter(lambda x: x, map(reg.match, fd)))
-
-    if not matches:
-        raise RuntimeError(
-            'Could not find the version information for requests_gssapi'
-            )
+    with (path / 'httpx_gssapi' / '__init__.py').open() as fd:
+        match = next(filter(None, map(reg.match, fd)), None)
 
-    return matches[0].group(1)
+    if match is None:
+        raise RuntimeError('Could not find the version for httpx_gssapi')
+    return match.group(1)
 
 
 setup(
-    name='requests-gssapi',
-    description=short_desc,
     long_description=long_desc,
-    author='Ian Cordasco, Cory Benfield, Michael Komitee, Robbie Harwood',
-    author_email='[email protected]',
-    url='https://github.com/pythongssapi/requests-gssapi',
-    packages=['requests_gssapi'],
-    package_data={'': ['LICENSE', 'AUTHORS']},
-    include_package_data=True,
     version=get_version(),
-    install_requires=[
-        'requests>=1.1.0',
-        'gssapi',
-    ],
-    test_suite='test_requests_gssapi',
-    tests_require=['mock'],
-    classifiers=[
-        "License :: OSI Approved :: ISC License (ISCL)"
-    ],
 )