11GSSAPI Console
22==============
33
4+ [ ![ PyPI version] ( https://badge.fury.io/py/gssapi_console.svg )] ( https://badge.fury.io/py/gssapi_console )
5+ [ ![ GitHub version] ( https://badge.fury.io/gh/pythongssapi%2Fgssapi-console.svg )] ( https://badge.fury.io/gh/pythongssapi%2Fgssapi-console )
6+
47* GSSAPI Console* allows provides an easy way to test out Python applications
58using GSSAPI in a self-contained environment.
69
@@ -11,22 +14,36 @@ Requirements
1114------------
1215
1316* [ python-gssapi] ( https://pypi.python.org/pypi/gssapi ) >= 1.1.0
14- * The required components for the environment in used
15- (for krb5, the full set of MIT krb5 executables are needed,
16- including those required to set up a KDC).
17+ * Requirements for the environment used (for example, the default environment is
18+ MIT krb5, which uses the [ k5test] ( https://pypi.python.org/pypi/k5test ) )
1719
1820Usage
1921-----
2022
21- * [ further information is available by running ` gssapi-console.py --help ` ] *
23+ * further information is available by running ` gssapi-console.py --help ` *
2224
2325The main executable of GSSAPI Console is ` gssapi-console.py ` . The basic
2426invocation works just like launching ` python ` -- use ` gssapi-console.py FILE `
2527to run a file in the established environment, or just run ` gssapi-console.py `
2628or ` gssapi-console.py -i ` to get an interactive environment (the ` -i ` flag
2729can be used with a file, just like ` python FILE -i ` ).
2830
29- You can use ` --realm-args key1=true,key2=false,... ` to pass specific arguments
30- to the realm constructor (the set of such keys is driver-dependent), and
31- ` --mech MECH_NAME ` can be used to specify a different driver (currently
32- only ` --mech krb5 ` will work).
31+ There are several additional flags that may be passed to ` gssapi-console.py ` :
32+
33+ * ` --realm-args key1=true,key2=false,... ` can be used to pass specific arguments
34+ to the realm constructor (the set of such keys is driver-dependent)
35+ * ` --mech MECH_NAME ` can be used to specify a different driver (currently, only
36+ ` --mech krb5 ` will work)
37+ * ` -a IDENTIFIER, --attach IDENTIFIER ` may be used to "attach" a new GSSAPI Console
38+ session to an environment set up by an existing GSSAPI Console session. The identifier
39+ will be noted at the top of the existing GSSAPI Console session as ` Session: IDENTIFIER ` .
40+ * ` -v, --verbose ` may be used to increase the verbosity of the logging level (generally to
41+ gain more details on what the driver is doing to set up the realm).
42+
43+ Additional GSSAPI Console drivers may be introduced using the ` gssapi_console.drivers `
44+ setuptools entry point. They should follow the ` gssapi_console.drivers.GSSAPIConsoleDriver `
45+ class.
46+
47+ GSSAPI Console provides a [ YALPT] ( https://pypi.python.org/pypi/yalpt ) environment driver for
48+ writing tutorials and literate python files involving GSSAPI. You can use it by passing
49+ ` -e gssapi ` to YALPT (it will use the default GSSAPI Console driver in this case).
0 commit comments