Rename to requests_gssapi

Signed-off-by: Robbie Harwood <rharwood@redhat.com>

Author: frozencemetery

.gitignore

@@ -3,5 +3,5 @@
 env/
 build/
 dist/
-requests_kerberos.egg-info/
+requests_gssapi.egg-info/
 

.travis.yml

@@ -6,4 +6,4 @@ python:
 
 install:
     - pip install .
-script: py.test test_requests_kerberos.py
+script: py.test test_requests_gssapi.py

README.rst

@@ -1,15 +1,15 @@
-requests Kerberos/GSSAPI authentication library
+requests GSSAPI authentication library
 ===============================================
 
 Requests is an HTTP library, written in Python, for human beings. This library
-adds optional Kerberos/GSSAPI authentication support and supports mutual
+adds optional GSSAPI authentication support and supports mutual
 authentication. Basic GET usage:
 
 
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth
+    >>> from requests_gssapi import HTTPKerberosAuth
     >>> r = requests.get("http://example.org", auth=HTTPKerberosAuth())
     ...
 
@@ -29,7 +29,7 @@ REQUIRED
 
 By default, ``HTTPKerberosAuth`` will require mutual authentication from the
 server, and if a server emits a non-error response which cannot be
-authenticated, a ``requests_kerberos.errors.MutualAuthenticationError`` will
+authenticated, a ``requests_gssapi.errors.MutualAuthenticationError`` will
 be raised. 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 mutual auth on errors,
@@ -39,9 +39,9 @@ setting ``sanitize_mutual_error_response=False``:
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth, REQUIRED
-    >>> kerberos_auth = HTTPKerberosAuth(mutual_authentication=REQUIRED, sanitize_mutual_error_response=False)
-    >>> r = requests.get("https://windows.example.org/wsman", auth=kerberos_auth)
+    >>> from requests_gssapi import HTTPKerberosAuth, REQUIRED
+    >>> gssapi_auth = HTTPKerberosAuth(mutual_authentication=REQUIRED, sanitize_mutual_error_response=False)
+    >>> r = requests.get("https://windows.example.org/wsman", auth=gssapi_auth)
     ...
 
 
@@ -54,12 +54,12 @@ preference when constructing your ``HTTPKerberosAuth`` object:
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth, OPTIONAL
-    >>> kerberos_auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL)
-    >>> r = requests.get("http://example.org", auth=kerberos_auth)
+    >>> from requests_gssapi import HTTPKerberosAuth, OPTIONAL
+    >>> gssapi_auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL)
+    >>> r = requests.get("http://example.org", auth=gssapi_auth)
     ...
 
-This will cause ``requests_kerberos`` to attempt mutual authentication if the
+This will cause ``requests_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.
 
@@ -72,44 +72,44 @@ authentication, you can do that as well:
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth, DISABLED
-    >>> kerberos_auth = HTTPKerberosAuth(mutual_authentication=DISABLED)
-    >>> r = requests.get("http://example.org", auth=kerberos_auth)
+    >>> from requests_gssapi import HTTPKerberosAuth, DISABLED
+    >>> gssapi_auth = HTTPKerberosAuth(mutual_authentication=DISABLED)
+    >>> r = requests.get("http://example.org", auth=gssapi_auth)
     ...
 
 Preemptive Authentication
 -------------------------
 
-``HTTPKerberosAuth`` can be forced to preemptively initiate the Kerberos
-GSS exchange and present a Kerberos ticket on the initial request (and all
+``HTTPKerberosAuth`` can be forced to preemptively initiate the GSSAPI
+exchange and present a token on the initial request (and all
 subsequent). By default, authentication only occurs after a
-``401 Unauthorized`` response containing a Kerberos or Negotiate challenge
+``401 Unauthorized`` response containing a Negotiate challenge
 is received from the origin server. This can cause mutual authentication
 failures for hosts that use a persistent connection (eg, Windows/WinRM), as
-no Kerberos challenges are sent after the initial auth handshake. This
+no GSSAPI challenges are sent after the initial auth handshake. This
 behavior can be altered by setting  ``force_preemptive=True``:
 
 .. code-block:: python
     
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth, REQUIRED
-    >>> kerberos_auth = HTTPKerberosAuth(mutual_authentication=REQUIRED, force_preemptive=True)
-    >>> r = requests.get("https://windows.example.org/wsman", auth=kerberos_auth)
+    >>> from requests_gssapi import HTTPKerberosAuth, REQUIRED
+    >>> gssapi_auth = HTTPKerberosAuth(mutual_authentication=REQUIRED, force_preemptive=True)
+    >>> r = requests.get("https://windows.example.org/wsman", auth=gssapi_auth)
     ...
 
 Hostname Override
 -----------------
 
 If communicating with a host whose DNS name doesn't match its
-kerberos hostname (eg, behind a content switch or load balancer),
-the hostname used for the Kerberos GSS exchange can be overridden by
+hostname (eg, behind a content switch or load balancer),
+the hostname used for the GSSAPI exchange can be overridden by
 setting the ``hostname_override`` arg:
 
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth, REQUIRED
-    >>> kerberos_auth = HTTPKerberosAuth(hostname_override="internalhost.local")
+    >>> from requests_gssapi import HTTPKerberosAuth, REQUIRED
+    >>> gssapi_auth = HTTPKerberosAuth(hostname_override="internalhost.local")
     >>> r = requests.get("https://externalhost.example.org/", auth=kerberos_auth)
     ...
 
@@ -119,34 +119,29 @@ Explicit Principal
 ``HTTPKerberosAuth`` normally uses the default principal (ie, the user for
 whom you last ran ``kinit`` or ``kswitch``, or an SSO credential if
 applicable). However, an explicit principal can be specified, which will
-cause Kerberos to look for a matching credential cache for the named user.
-This feature depends on OS support for collection-type credential caches,
-as well as working principal support in PyKerberos (it is broken in many
-builds). An explicit principal can be specified with the ``principal`` arg:
+cause GSSAPI to look for a matching credential cache for the named user.
+This feature depends on OS support for collection-type credential caches.
+An explicit principal can be specified with the ``principal`` arg:
 
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth, REQUIRED
-    >>> kerberos_auth = HTTPKerberosAuth(principal="user@REALM")
-    >>> r = requests.get("http://example.org", auth=kerberos_auth)
+    >>> from requests_gssapi import HTTPKerberosAuth, REQUIRED
+    >>> gssapi_auth = HTTPKerberosAuth(principal="user@REALM")
+    >>> r = requests.get("http://example.org", auth=gssapi_auth)
     ...
 
-On Windows, WinKerberos is used instead of PyKerberos. WinKerberos allows the
-use of arbitrary principals instead of a credential cache. Passwords can be
-specified by following the form ``user@realm:password`` for ``principal``.
-
 Delegation
 ----------
 
-``requests_kerberos`` supports credential delegation (``GSS_C_DELEG_FLAG``).
+``requests_gssapi`` supports credential delegation (``GSS_C_DELEG_FLAG``).
 To enable delegation of credentials to a server that requests delegation, pass
 ``delegate=True`` to ``HTTPKerberosAuth``:
 
 .. code-block:: python
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth
+    >>> from requests_gssapi import HTTPKerberosAuth
     >>> r = requests.get("http://example.org", auth=HTTPKerberosAuth(delegate=True))
     ...
 
@@ -158,10 +153,10 @@ Logging
 
 This library makes extensive use of Python's logging facilities.
 
-Log messages are logged to the ``requests_kerberos`` and
-``requests_kerberos.kerberos_`` named loggers.
+Log messages are logged to the ``requests_gssapi`` and
+``requests_gssapi.gssapi`` named loggers.
 
 If you are having difficulty we suggest you configure logging. Issues with the
-underlying kerberos libraries will be made apparent. Additionally, copious debug
+underlying GSSAPI libraries will be made apparent. Additionally, copious debug
 information is made available which may assist in troubleshooting if you
 increase your log level all the way up to debug.

requests_kerberos/__init__.py requests_gssapi/__init__.pyrequests_kerberos/__init__.py renamed to requests_gssapi/__init__.py

@@ -1,20 +1,20 @@
 """
-requests Kerberos/GSSAPI authentication library
+requests GSSAPI authentication library
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Requests is an HTTP library, written in Python, for human beings. This library
-adds optional Kerberos/GSSAPI authentication support and supports mutual
+adds optional GSSAPI authentication support and supports mutual
 authentication. Basic GET usage:
 
     >>> import requests
-    >>> from requests_kerberos import HTTPKerberosAuth
+    >>> from requests_gssapi import HTTPKerberosAuth
     >>> r = requests.get("http://example.org", auth=HTTPKerberosAuth())
 
 The entire `requests.api` should be supported.
 """
 import logging
 
-from .kerberos_ import HTTPKerberosAuth, REQUIRED, OPTIONAL, DISABLED
+from .gssapi_ import HTTPKerberosAuth, REQUIRED, OPTIONAL, DISABLED
 from .exceptions import MutualAuthenticationError
 from .compat import NullHandler
 

requests_kerberos/compat.py requests_gssapi/compat.pyrequests_kerberos/compat.py renamed to requests_gssapi/compat.py

@@ -1,5 +1,5 @@
 """
-requests_kerberos.exceptions
+requests_gssapi.exceptions
 ~~~~~~~~~~~~~~~~~~~
 
 This module contains the set of exceptions.

requests_kerberos/exceptions.py requests_gssapi/exceptions.pyrequests_kerberos/exceptions.py renamed to requests_gssapi/exceptions.py

@@ -9,7 +9,7 @@
 hist_fd = os.path.join(path, 'HISTORY.rst')
 
 long_desc = ''
-short_desc = 'A Kerberos authentication handler for python-requests'
+short_desc = 'A GSSAPI authentication handler for python-requests'
 
 if os.path.isfile(desc_fd):
     with open(desc_fd) as fd:
@@ -25,25 +25,25 @@ def get_version():
     Simple function to extract the current version using regular expressions.
     """
     reg = re.compile(r'__version__ = [\'"]([^\'"]*)[\'"]')
-    with open('requests_kerberos/__init__.py') as fd:
+    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_kerberos'
+            'Could not find the version information for requests_gssapi'
             )
 
     return matches[0].group(1)
 
 
 setup(
-    name='requests-kerberos',
+    name='requests-gssapi',
     description=short_desc,
     long_description=long_desc,
-    author='Ian Cordasco, Cory Benfield, Michael Komitee',
-    author_email='graffatcolmingov@gmail.com',
-    url='https://github.com/requests/requests-kerberos',
-    packages=['requests_kerberos'],
+    author='Ian Cordasco, Cory Benfield, Michael Komitee, Robbie Harwood',
+    author_email='rharwood@redhat.com',
+    url='https://github.com/frozencemetery/requests-gssapi',
+    packages=['requests_gssapi'],
     package_data={'': ['LICENSE', 'AUTHORS']},
     include_package_data=True,
     version=get_version(),
@@ -54,6 +54,6 @@ def get_version():
         ':sys_platform=="win32"': ['winkerberos>=0.5.0'],
         ':sys_platform!="win32"': ['pykerberos>=1.1.8,<2.0.0'],
     },
-    test_suite='test_requests_kerberos',
+    test_suite='test_requests_gssapi',
     tests_require=['mock'],
 )