updated docs

Author: degagne

README.md

@@ -1,10 +1,10 @@
 # python-krb5ticket
 
-[![PythonSSH Version](https://img.shields.io/pypi/v/python-krb5ticket?style=for-the-badge)](https://pypi.org/project/python-krb5ticket/)
-[![PythonSSH Status](https://img.shields.io/pypi/status/python-krb5ticket?style=for-the-badge)](https://pypi.org/project/python-krb5ticket)
-[![PythonSSH Python Versions](https://img.shields.io/pypi/pyversions/python-krb5ticket?style=for-the-badge)](https://pypi.org/project/python-krb5ticket/)
-[![PythonSSH Release](https://img.shields.io/github/release/degagne/python-krb5ticket?style=for-the-badge)](https://github.com/degagne/python-krb5ticket/releases/)
-[![PythonSSH License](https://img.shields.io/github/license/degagne/python-krb5ticket?style=for-the-badge)](https://github.com/degagne/python-krb5ticket/blob/master/LICENSE)
+[![PythonKrb5Ticket Version](https://img.shields.io/pypi/v/python-krb5ticket?style=for-the-badge)](https://pypi.org/project/python-krb5ticket/)
+[![PythonKrb5Ticket Status](https://img.shields.io/pypi/status/python-krb5ticket?style=for-the-badge)](https://pypi.org/project/python-krb5ticket)
+[![PythonKrb5Ticket Python Versions](https://img.shields.io/pypi/pyversions/python-krb5ticket?style=for-the-badge)](https://pypi.org/project/python-krb5ticket/)
+[![PythonKrb5Ticket Release](https://img.shields.io/github/release/degagne/python-krb5ticket?style=for-the-badge)](https://github.com/degagne/python-krb5ticket/releases/)
+[![PythonKrb5Ticket License](https://img.shields.io/github/license/degagne/python-krb5ticket?style=for-the-badge)](https://github.com/degagne/python-krb5ticket/blob/master/LICENSE)
 
 **python-krb5ticket** provides a convenient interface to create Kerberos keytab files and to manage ticket-granting tickets (TGTs).
 

docs/apidoc/krb5.rst

@@ -1,7 +1,7 @@
 ####
-Krb5
+krb5
 ####
 
-.. autoclass:: krb5.Krb5
+.. autoclass:: krb5ticket.Krb5
     :members:
     :inherited-members:

docs/apidoc/ktutil.rst

@@ -1,7 +1,7 @@
 ######
-Ktutil
+ktutil
 ######
 
-.. autoclass:: krb5.ktutil
+.. autoclass:: krb5ticket.ktutil
     :members:
     :inherited-members:

docs/apidoc/ktutil_helpers.rst

@@ -1,10 +1,7 @@
 ##############
-Ktutil Helpers
+ktutil_helpers
 ##############
 
-The ``ktutil_helpers`` module, provides easy-to-use functions to create, 
-delete or list Kerberos keytab entries.
-
-.. automodule:: krb5.ktutil_helpers
+.. automodule:: krb5ticket.ktutil_helpers
     :members:
     :inherited-members:

docs/apidoc/modules.rst

@@ -4,6 +4,6 @@ API Documentation
 
 .. toctree::
 
-    ktutil <ktutil>
-    ktutil_helpers <ktutil_helpers>
-    krb5 <krb5>
+    ktutil
+    ktutil_helpers
+    krb5

docs/conf.py

@@ -20,7 +20,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = imp.load_source("krb5.version", os.path.join("../krb5", "version.py")).version
+release = imp.load_source("krb5ticket.version", os.path.join("../krb5ticket", "version.py")).version
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

docs/index.rst

@@ -44,9 +44,9 @@ Acquires Kerberos ticket-granting ticket (TGT) with keytab file.
     :caption: Python
     :linenos:
 
-    import krb5
+    import krb5ticket
 
-    krb = krb5.Krb5("[email protected]", "/tmp/krb5cc_user")
+    krb = krb5ticket.Krb5("[email protected]", "/tmp/krb5cc_user")
     krb.acquire_with_keytab("/home/user/user.keytab")
 
 Acquires Kerberos ticket-granting ticket (TGT) with password.
@@ -55,9 +55,9 @@ Acquires Kerberos ticket-granting ticket (TGT) with password.
     :caption: Python
     :linenos:
 
-    from krb5 import Krb5
+    from krb5ticket import Krb5
 
-    krb = Krb5("[email protected]", "/tmp/krb5cc_user")
+    krb = krb5ticket("[email protected]", "/tmp/krb5cc_user")
     krb.acquire_with_password("thisismypassword")
 
 ktutil
@@ -76,7 +76,7 @@ Reads the Kerberos V5 keytab file keytab into the current keylist, then prints t
     :caption: Python
     :linenos:
 
-    from krb5 import ktutil
+    from krb5ticket import ktutil
 
     KEYTAB = "jsmith.keytab"
 
@@ -110,7 +110,7 @@ to a keytab file.
     :caption: Python
     :linenos:
 
-    from krb5 import ktutil
+    from krb5ticket import ktutil
 
     PRINCIPAL = "[email protected]"
     PASSWORD = "securepassword"
@@ -137,7 +137,7 @@ Deletes an entry to the current keylist and writes it to a ``NEW`` keytab file.
     :caption: Python
     :linenos:
 
-    from krb5 import ktutil
+    from krb5ticket import ktutil
 
     KEYTAB = "jsmith.keytab"
     NEW_KEYTAB = "jsmith_new.keytab"

krb5ticket/version.py

@@ -1 +1 @@
-version = "1.0.1"
+version = "1.0.2"