source: main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/__init__.py @ 6494

Last change on this file since 6494 was 6492, checked in by uli, 14 years ago

Add docs and make all work properly.

File size: 1009 bytes
Line 
1"""Access codes (aka PINs)
2--------------------------
3
4Access codes are special objects used for identifying users. Each
5access code has a portal-wide unique number.
6
7Main content components are defined in
8:mod:`waeup.sirp.accesscodes.accesscodes`. This subpackage also
9provides a _catalog_ to lookup any access code quickly and a
10_workflow_ to guarantee consistent states and transitions when dealing
11with it.
12
13We also provide UI components to generate, archive, import and
14reimport access codes or batches thereof. These parts are defined in
15:mod:`waeup.sirp.accesscodes.browser`.
16
17"""
18from waeup.sirp.accesscodes.accesscodes import (
19    get_access_code, invalidate_accesscode, disable_accesscode,
20    reenable_accesscode, AccessCode, AccessCodeBatch, AccessCodeBatchContainer)
21
22# Public API of this submodule
23__all__ = [
24    'AccessCodeBatchContainer',
25    'AccessCodeBatch',
26    'AccessCode',
27    'get_access_code',
28    'invalidate_accesscode',
29    'disable_accesscode',
30    'reenable_accesscode',
31    ]
Note: See TracBrowser for help on using the repository browser.