From 7318e29cb7931f440e53b5dd56c8442a5aae9156 Mon Sep 17 00:00:00 2001 From: Solly Ross Date: Wed, 22 Apr 2015 21:24:31 -0400 Subject: [PATCH] Add inline documentation for low-level module This commit adds a docstring to `gssapi.raw` so that `help(gssapi.raw)` returns useful information. --- gssapi/raw/__init__.py | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/gssapi/raw/__init__.py b/gssapi/raw/__init__.py index ee27a5f4..eb1d290b 100644 --- a/gssapi/raw/__init__.py +++ b/gssapi/raw/__init__.py @@ -1,3 +1,39 @@ +"""Low-Level GSSAPI Bindings + +The low-level API presents a series of methods designed +to closely mimic the C API presented in RFC 2744 and +associated RFCs. + +In this API, classes are simply thin wrappers around C +constructs, and generally lack instance methods. However, +classes will automatically free associated memory (so the +release_xyz methods are not necessary to call). + +The core RFC 2744 components are organized into the following +submodules: + + gssapi.raw.names -- Names + + gssapi.raw.creds -- Credentials + + gssapi.raw.sec_contexts -- Security Contexts + + gssapi.raw.message -- Message encryption, decryption, etc + + gssapi.raw.misc -- Miscellaneous functions + + gssapi.raw.types -- Miscellaneous types (enums, etc) + + gssapi.raw.exceptions -- Exceptions + +Additionally, a number of extensions may be present. All extensions +are in modules of the form `gssapi.raw.ext_xyz`. + +All available functions and classes can be accessed directly from this +module (`gssapi.raw`) -- it is unneccessary to directly import submodules. +""" + + import pkgutil import importlib